Files
Kigi-CLI/crates/codegen/kigi-tools/src/implementations/kigi/lsp/mod.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

115 lines
3.7 KiB
Rust

//! `lsp` tool - code intelligence via language servers.
//!
//! The `Tool` trait wrapper; the backend dispatch lives in `implementations::lsp`.
use std::sync::Arc;
use crate::implementations::lsp::{LspBackend, LspToolInput};
use crate::types::output::ToolOutput;
use crate::types::tool::{ToolKind, ToolNamespace};
#[derive(serde::Serialize, serde::Deserialize)]
pub struct LspToolOutput(pub String);
impl kigi_tool_runtime::ToolOutput for LspToolOutput {}
impl From<LspToolOutput> for ToolOutput {
fn from(o: LspToolOutput) -> Self {
ToolOutput::Text(o.0.into())
}
}
#[derive(Debug, Default)]
pub struct LspTool;
impl crate::types::tool_metadata::ToolMetadata for LspTool {
fn kind(&self) -> ToolKind {
ToolKind::Lsp
}
fn tool_namespace(&self) -> ToolNamespace {
ToolNamespace::Kigi
}
fn description_template(&self) -> &str {
r#"Code intelligence via language servers.${%- if tools.by_kind.search and tools.by_kind.read %} Prefer over ${{ tools.by_kind.search }}/${{ tools.by_kind.read }} for understanding code.${%- endif %}
Operations: goToDefinition (jump to where a symbol is defined), findReferences (all usages of a symbol), hover (type info/docs at a position), goToImplementation (trait/interface implementations), documentSymbol (list all symbols in a file), workspaceSymbol (search symbols by name across the workspace — requires query parameter, not file_path).
Requires file_path + line + character for position-based operations."#
}
fn emitted_notifications(&self) -> &'static [&'static str] {
&[
"LspServerCrashed",
"LspServerFailed",
"LspServerReady",
"LspServerRetrying",
"LspServerStarting",
]
}
}
impl kigi_tool_runtime::Tool for LspTool {
type Args = LspToolInput;
type Output = LspToolOutput;
fn id(&self) -> kigi_tool_protocol::ToolId {
kigi_tool_protocol::ToolId::new("lsp").expect("valid tool id")
}
fn description(
&self,
_ctx: &::kigi_tool_runtime::ListToolsContext,
) -> kigi_tool_types::ToolDescription {
kigi_tool_types::ToolDescription::new(
"lsp",
crate::types::tool_metadata::ToolMetadata::description_template(self),
)
}
fn capabilities(&self) -> kigi_tool_protocol::ToolCapabilities {
kigi_tool_protocol::ToolCapabilities {
is_read_only: true,
tool_scope: Some(kigi_tool_protocol::ToolScope::Read),
..Default::default()
}
}
#[tracing::instrument(
name = "tool.lsp",
skip_all,
fields(operation = %input.operation)
)]
async fn run(
&self,
ctx: kigi_tool_runtime::ToolCallContext,
input: LspToolInput,
) -> Result<LspToolOutput, kigi_tool_runtime::ToolError> {
use crate::types::tool_metadata::shared_resources;
let resources = shared_resources(&ctx)?;
let handle;
{
let res = resources.lock().await;
handle = res
.get::<Arc<dyn LspBackend>>()
.ok_or_else(|| {
kigi_tool_runtime::ToolError::custom(
"process_manager",
"LSP tool is unavailable. Configure ~/.kigi/lsp.json or <cwd>/.kigi/lsp.json and ensure the language server can start.",
)
})?
.clone();
}
let result = handle.dispatch(&input).await;
if result.is_error {
Err(kigi_tool_runtime::ToolError::custom(
"process_manager",
result.text,
))
} else {
Ok(LspToolOutput(result.text))
}
}
}