lsp-docs
关于
This skill provides a three-tier fallback documentation lookup for code symbols when standard LSP hover text is missing or insufficient. It sequentially checks hover info, offline toolchain documentation, and finally source definitions, particularly useful for unindexed dependencies. It's a read-only tool that requires the agent-lsp MCP server and works with fully-qualified symbol names.
快速安装
Claude Code
推荐npx skills add blackwell-systems/agent-lsp -a claude-code/plugin add https://github.com/blackwell-systems/agent-lspgit clone https://github.com/blackwell-systems/agent-lsp.git ~/.claude/skills/lsp-docs在 Claude Code 中复制并粘贴此命令以安装该技能
技能文档
Requires the agent-lsp MCP server.
lsp-docs
Three-tier documentation lookup for any symbol. Works when the language server is unavailable, when hover returns empty results, or when the symbol lives in a transitive dependency that gopls or pyright does not index.
Read-only — does not modify any files.
Invocation: User provides symbol_name in fully-qualified form (e.g.
"fmt.Println", "std::vec::Vec::new", "os.path.join"). Optionally provide
file_path for any file in the same module, which improves Go package resolution.
Decision table
| Situation | Recommended tier |
|---|---|
| Symbol in current workspace | Tier 1 (hover) |
| Symbol in direct dependency | Tier 2 (toolchain doc) |
| Symbol in transitive dep (not indexed by LSP) | Tier 2 |
| No LSP server available | Tier 2 → Tier 3 |
| No toolchain installed (e.g., Rust without cargo) | Tier 3 |
Tier 1 — LSP hover (fast, live, position-based)
Call inspect_symbol with the file path and cursor position (1-based).
mcp__lsp__inspect_symbol({
"file_path": "/abs/path/to/file.go",
"line": 42,
"column": 8
})
If the result contains a non-empty contents field with useful type and doc
information, stop here and return it. Hover is the fastest path and should
always be tried first.
If hover returns empty contents, or the language server is not initialized,
proceed to Tier 2.
Tier 2 — Offline toolchain documentation (authoritative, name-based)
Call get_symbol_documentation with the fully-qualified symbol name and
language_id. This fetches documentation from the local toolchain (go doc,
pydoc, cargo doc) without requiring an LSP session. Works for transitive
dependencies that the language server does not index.
mcp__lsp__get_symbol_documentation({
"symbol": "fmt.Println",
"language_id": "go",
"file_path": "/abs/path/to/any/file/in/the/module.go", // optional, improves Go pkg resolution
"format": "markdown" // optional: wraps signature in code fence
})
Interpreting the result:
- If
source == "toolchain": return thedocandsignaturefields to the user. These are authoritative — sourced directly from the installed toolchain, ANSI-stripped, and ready for display. - If
source == "error": note theerrorfield (toolchain failure reason) and proceed to Tier 3.
Tier 3 — Source definition (last resort)
Call go_to_definition to navigate to the symbol definition, then call
get_symbol_source to extract the source text. This always works when the
symbol exists in the workspace or module cache, even without a language server.
mcp__lsp__go_to_definition({
"file_path": "/abs/path/to/caller.go",
"line": 42,
"column": 8
})
// → returns definition location
mcp__lsp__get_symbol_source({
"file_path": "<definition file from above>",
"line": <definition line from above>
})
// → returns full function/type source text
Present the source text to the user with a note that it is raw source, not rendered documentation.
lsp-impact integration note
Before running lsp-impact on an unfamiliar symbol, call
get_symbol_documentation to understand its signature and semantics. This
prevents misinterpreting the impact report due to incorrect assumptions about
what the symbol does.
Example
Goal: look up documentation for http.ListenAndServe in a Go project
Tier 1 — inspect_symbol: cursor on "ListenAndServe" in main.go:14:6
→ contents: "" (empty — server not initialized)
Proceed to Tier 2.
Tier 2 — get_symbol_documentation:
symbol: "net/http.ListenAndServe"
language_id: "go"
file_path: "/Users/you/code/myapp/main.go"
format: "markdown"
Result:
{
"symbol": "net/http.ListenAndServe",
"language": "go",
"source": "toolchain",
"doc": "func ListenAndServe(addr string, handler http.Handler) error\n\nListenAndServe listens on the TCP network address addr and then calls Serve...",
"signature": "func ListenAndServe(addr string, handler http.Handler) error",
"error": ""
}
source == "toolchain" → return doc and signature to user. Done.
Tier 3 — skipped (Tier 2 succeeded)
GitHub 仓库
相关推荐技能
railway-docs
文档Railway Docs Skill可实时获取最新的Railway官方文档,确保回答的准确性。当开发者询问Railway功能特性、工作原理或分享docs.railway.com链接时,应优先使用此技能。它通过专门的LLM优化文档源提供最新信息,避免依赖过时记忆来回答技术问题。
n8n-code-python
文档该Skill为在n8n平台的Python代码节点中编写代码提供专家指导,特别适用于需要使用_input/_json/_node语法、Python标准库或了解n8n中Python限制的场景。它强调JavaScript应作为首选方案,仅当需要特定Python功能或对Python语法更熟悉时才使用Python。Skill提供了快速入门模板和关键注意事项,帮助开发者在n8n中高效编写Python代码。
archon
文档Archon Skill为开发者提供了基于RAG的语义搜索和项目任务管理功能,可通过REST API访问知识库。它支持文档搜索、网站爬取、文件上传和版本控制,适用于技术文档查询和项目管理场景。首次使用时需要配置Archon主机地址,建议在处理外部文档时优先使用该Skill。
n8n-code-javascript
文档这个Skill为n8n工作流中的JavaScript代码节点提供专业指导,涵盖数据处理、HTTP请求和日期操作等核心场景。它详细解释了如何正确使用n8n特有的`$input`/`$json`语法、`$helpers`工具以及DateTime对象,并包含关键的错误排查和模式选择建议。开发者通过该Skill能快速掌握Code节点的正确返回格式、数据访问方法和常见陷阱解决方案。
