Files
Kigi-CLI/crates/common/kigi-tool-runtime/src/lib.rs
T
ZacharyZhang-NY a02b555e66 docs(comments): rewrite comments across all crates to the guidelines
Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
2026-07-23 16:55:39 -04:00

45 lines
1.7 KiB
Rust

//! Unified tool runtime contract.
//!
//! Adapters for individual tool sources re-export from here so every tool
//! author sees the same surface.
#![forbid(unsafe_code)]
pub mod context;
pub mod dispatch;
pub mod error;
pub mod local_registry;
pub mod notification;
pub mod render;
pub mod search;
pub mod streaming;
pub mod tool;
pub use context::{
BehaviorVersion, Cancellation, Cwd, ListToolsContext, SessionContext, ToolCallContext,
TraceContext, TypedExtensions, WorkspaceViewerContext,
};
pub use dispatch::ToolDispatch;
pub use error::{ToolError, ToolErrorKind};
pub use local_registry::LocalRegistry;
pub use notification::{
BashExecutionBackgrounded, BashExecutionComplete, BashExecutionFailed, BashExecutionTimeout,
BashNotificationBase, BashOutputChunk, FileRead, FileWritten, LspServerCrashed,
LspServerFailed, LspServerReady, LspServerRetrying, LspServerStarting, MonitorEvent,
PlanModeEntered, PlanModeExited, ScheduledTaskCreated, ScheduledTaskFired,
ScheduledTaskRemoved, TaskKind, TaskSnapshot, ToolNotification, ToolNotificationHandle,
UserQuestionAsked,
};
pub use render::{
ModelOutputExtractor, ToolChatCompletion, ToolChatCompletionResponse, ToolCodeExecutionResult,
ToolOutput, ToolStreamError, extract_content_blocks, extractor_for,
};
pub use search::{SearchSnapshot, ServerSummary, ToolIndex, ToolSearchIndex, ToolSearchResult};
pub use streaming::{PartialResultPayload, stream_chunk};
pub use tool::{
ArcTool, ArcToolFamily, ContentBlock, Tool, ToolDyn, ToolFamily, ToolProgress, ToolStream,
ToolStreamItem, ToolVariant, TypedToolOutput, terminal_only, with_progress,
};
pub use kigi_tool_protocol::{StreamingSpec, ToolCallId, ToolCapabilities, ToolId, ToolScope};