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).
This commit is contained in:
1 parent
ff0fb56c67
commit
a02b555e66
1458 files changed
+10729
-21750
No files matched your search
@@ -5,23 +5,20 @@
|
||||
//! Reference these constants instead of re-typing the literals so the agent and
|
||||
//! SDK can't drift apart.
|
||||
|
||||
/// Forward tool-invocation method (client -> agent): `kigi/mcp/call`.
|
||||
///
|
||||
/// The pager/client asks the agent to invoke an MCP tool on a server the agent is
|
||||
/// connected to, outside the LLM loop. See `extensions::mcp::handle_call`.
|
||||
/// Forward tool invocation (client -> agent): the pager/client asks the agent to
|
||||
/// invoke a tool on an MCP server the agent is connected to, outside the LLM loop.
|
||||
/// See `extensions::mcp::handle_call`.
|
||||
pub const MCP_CALL: &str = "kigi/mcp/call";
|
||||
|
||||
/// Reverse zero-IPC tool-invocation method (agent -> client): `kigi/mcp/sdk_call`.
|
||||
///
|
||||
/// The agent invokes a tool that lives in the SDK's in-process MCP server by sending
|
||||
/// the MCP JSON-RPC message back to the client over the ACP reverse channel. Distinct
|
||||
/// from [`MCP_CALL`] so the two disjoint schemas don't share a method string for
|
||||
/// metrics/tracing. See the agent-side ACP invoker that handles this method.
|
||||
/// Reverse zero-IPC tool invocation (agent -> client): the agent invokes a tool
|
||||
/// living in the SDK's in-process MCP server by sending the MCP JSON-RPC message
|
||||
/// back over the ACP reverse channel. Distinct from [`MCP_CALL`] so the two
|
||||
/// disjoint schemas don't share a method string for metrics/tracing.
|
||||
pub const MCP_SDK_CALL: &str = "kigi/mcp/sdk_call";
|
||||
|
||||
/// `session/new` `_meta` key listing in-process SDK MCP servers: `kigi/mcp/servers`.
|
||||
/// `session/new` `_meta` key listing in-process SDK MCP servers.
|
||||
pub const MCP_SERVERS: &str = "kigi/mcp/servers";
|
||||
|
||||
/// `initialize` `_meta` capability flag advertising in-process SDK MCP support
|
||||
/// (enables the SDK's `transport="acp"`): `kigi/mcp/sdk`.
|
||||
/// `initialize` `_meta` capability flag advertising in-process SDK MCP support,
|
||||
/// which enables the SDK's `transport="acp"`.
|
||||
pub const MCP_SDK: &str = "kigi/mcp/sdk";
|
||||
Reference in new issue
Block a user