lspz 0.9.3

AI-friendly LSP compression proxy
Documentation

lspz

lsp zip — 压缩 LSP 消息,给 AI 智能体省 token

快速开始 · 架构设计 · API 文档 · 文档书


lspz 跑在 AI 编码智能体和 LSP 服务器之间。它拦截服务器响应(诊断、补全、符号、悬停等),重写成更紧凑的格式,少用不少 token。按 token 计费或者上下文窗口有限的时候尤其有用。

工作原理

Agent (LSP 客户端) ←→ lspz ←→ LSP 服务器 (rust-analyzer, gopls, ...)

客户端发给服务器的消息原样透传。服务器返回的响应经过一组拦截器:去掉冗余字段、去重、编码成紧凑格式。任何拦截器出错就转发原始消息——不会搞坏你的 LSP 会话。

三种用法

— 嵌入你自己的 Rust 智能体:

[dependencies]
lspz = { version = "0.9", default-features = false }

CLI 代理 — 直接替换你的 LSP 服务器命令:

lspz proxy --backend rust-analyzer

MCP 服务器 — 把 LSP 能力暴露为 MCP 工具,给 Claude Desktop 等客户端用:

lspz mcp

压缩效果

用 tiktoken 在真实 LSP 服务器输出上测的。TOON(Token-Oriented Object Notation)是默认输出格式。

拦截器 LSP 方法 紧凑格式节省 TOON 节省
DiagnosticsCompressor textDocument/publishDiagnostics 73.5% 76.6%
HoverCompressor textDocument/hover 1.6% 23.8%
DocumentSymbolCompressor textDocument/documentSymbol 33.0% 72.1%
CompletionCompressor textDocument/completion 16.9%
LocationCompressor references/definition/... 60–85%
WorkspaceDiagnosticCompressor workspace/diagnostic 83–90%
WorkspaceSymbolCompressor workspace/symbol 70–76%
CappingInterceptor 任意大响应 80–95%

完整数据见 benchmarks.md

输出格式

格式 说明 适用场景
toon(默认) 自描述行协议 + 表格 LLM 直接消费
compact 缩短 JSON 字段名 需要结构化数据时
passthrough 原始 LSP JSON 不动 调试

Feature flags

Flag 启用内容 默认
cli lspz 二进制(clap、tracing-subscriber)
mcp MCP 服务器(rmcp)
agent-sdk AgentHandle + AgentPool(隐含 mcp
transport-tcp TcpTransport 关(代码始终包含)
transport-websocket WsTransport

Agent SDK

把 LSP 能力嵌入你自己的智能体。支持 10 种查询方法、文件同步、重构操作:

use lspz::agent_sdk::AgentHandle;

let mut agent = AgentHandle::builder()
    .backend("rust-analyzer")
    .language("rust")
    .workspace_root("/home/user/project")
    .start()
    .await?;

let diags = agent.get_diagnostics("file:///home/user/project/src/main.rs").await?;
let completions = agent.get_completions("file:///home/user/project/src/main.rs", 42, 10).await?;
let edits = agent.rename("file:///home/user/project/src/main.rs", 10, 5, "new_name").await?;

agent.shutdown().await?;

完整 API 见 Agent 集成指南

快速验证

cargo run --example compress-demo   # 展示各拦截器的 token 节省
cargo bench                         # Criterion 吞吐量基准
just qa                             # fmt + clippy + test + doc-check

文档

许可证

MIT