lsp-docs

Topics in the source

• lsp-docs
• Decision table
• Tier 1 — LSP hover (fast, live, position-based)
• Tier 2 — Offline toolchain documentation (authoritative, name-based)
• Tier 3 — Source definition (last resort)
• lsp-impact integration note
• Example

Requires the agent-lsp MCP server. 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 symbolname in fully-qualified form (e.g. "fmt.Println", "std::vec::Vec::new", "os.path.join"). Optionally provide filepath for any file in the same module, which improves Go package resolution. -- | 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 | -- Call inspectsymbol with the file path and cursor position (1-based). 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. -- Ca

This is an excerpt. Refer to the complete source and its current requirements.