Octocode MCP
Octocode MCP is an AI-optimized code assistant for advanced GitHub and npm/PyPI ecosystem exploration and analysis.
GitHub Repository Discovery & Analysis: Search and analyze repositories (including private ones) by topics, languages, stars, activity, and explore their detailed structures
Code Search & Content Retrieval: Perform semantic code searches and fetch file contents with token optimization and fallback handling
Project History & Collaboration Research: Analyze commits (with diffs), issues, and pull requests to understand project evolution and team collaboration
Package Ecosystem Intelligence: Search and retrieve comprehensive metadata across npm and PyPI packages for dependency analysis and discovery
AI Context Generation: Extract token-efficient context from diverse code resources to enhance AI capabilities for code analysis and documentation
Enterprise & Security: Support private organizations with production-ready security features like secret detection and content sanitization
API Status Verification: Check GitHub/npm connections, organizations, and access permissions
Integration for supporting the developer through the Buy Me a Coffee platform
Provides deep search and discovery across GitHub repositories, enabling access to code, issues, pull requests, and commit histories from both public and private repositories while respecting organizational permissions
Provides specialized search capabilities for Next.js applications, particularly for finding authentication patterns and implementation examples
Enables package discovery and analysis in the Node.js ecosystem, with capabilities to research metadata, dependencies, and repository connections
Allows exploration of Python packages with cross-ecosystem comparison capabilities
Offers targeted research into React's implementation details, including specific features like concurrent rendering
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Octocode MCPfind popular React component libraries with TypeScript support"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Octocode: agentic research platform
Evidence-first code research for AI agents and developers.
Octocode researches your local code and external code alike (GitHub repositories, PRs, npm) with one toolset: ripgrep + AST search, trees, precise reads, and LSP. Use it as a CLI or MCP server, backed by a Rust engine for fast, token-efficient results across single files or mega-repos.
Table of contents
Related MCP server: MCP Indexer
Quick start
Prerequisites: Node.js 20.12+
1. Run the Octocode CLI with npx
npx octocode --help2. Authenticate with GitHub - optional, but unlocks private repositories and higher API rate limits:
npx octocode auth login
npx octocode status # verify the active token source3. Choose your interface. Same tools and Rust engine on both. (Clone is on by default in the CLI, opt-in for MCP.)
🖥️ CLI - research straight from your terminal:
npx octocode🤖 MCP - one-click install:
Claude Code:
claude mcp add-json octocode --scope user '{"command":"npx","type":"stdio","args":["octocode-mcp@latest"]}'Any other client: npx octocode install
Use it as an MCP server
Add to your MCP client config (or use a one-click install above):
{
"octocode": {
"command": "npx",
"type": "stdio",
"args": ["octocode-mcp@latest"]
}
}Put a GitHub token and options under env (see Configuration).
Use it as an agentic-friendly CLI
Run npx octocode and agents figure out the rest. The bare command prints built-in usage and the full tool catalog, so any coding agent knows how to drive it out of the box, no MCP client or extra wiring required.
npx octocode # self-describing usage for agents
npx octocode tools # list every tool
npx octocode tools localSearchCode --scheme # inspect a tool's schemaEvery MCP tool is also a plain command: JSON in, token-efficient YAML out. Local paths route to local tools; owner/repo[/path] routes to GitHub.
npx octocode tools localSearchCode \
--queries '{"path":".","searchText":"authenticate","maxFiles":20}'results:
- id: localSearchCode-1
data:
files:
- path: src/auth.ts
matches:
- line: 12
value: "export async function authenticate(req: Request) {"Learn more at octocode.ai.
Why Octocode
Agents code better from evidence than from guesses. Octocode researches two worlds with one flow, your local code and external code on GitHub and npm, and hands back compact, citable context before an agent changes, reviews, or explains code. Code is truth; context is the map.
Most tools do one slice (web search, or grep your repository) and hand back a fixed blob. Octocode covers the whole loop and lets the agent decide what data it needs next:
Agent-driven, efficient flows. Instead of one-shot dumps, Octocode chains cheap steps into an optimized research flow: broad code search, then fetch only the exact matched lines/region, with smart pagination and out-of-the-box minification so the model never over-fetches. Every result carries next-step hints to the cheapest follow-up.
Scales to monorepos. Spot a pattern in one repository, follow the PR that introduced it, then trace it across other repositories and your own files, without leaving the chat. Clone any repository and study it locally.
Smart GitHub flow. Parallel bulk queries across code, PRs, commits, issues, and repositories, all with the same search-broad, read-narrow, trace-semantically discipline.
Works without GitHub. Clone any repository and point the local tools (search, AST, LSP, content) at it, same evidence-first flow.
Reads shape, not noise. On-the-fly minify/skeletonize across 70+ languages: a 100 KB file in a few hundred tokens, not walls of boilerplate.
Fast, self-contained. Search, parsing, navigation, and redaction run in one prebuilt Rust engine: quick on a laptop or a mega-repo, nothing extra to install.
Safe by default. Every byte to the model is scanned and secrets redacted first (see Security).
What you can do (whenever the next step needs proven context, not a guess):
Need | Use Octocode to |
Codebase questions | Search local or GitHub code, read exact regions, browse trees, and carry file/line anchors into the answer. |
Implementation research | Compare patterns across repositories, npm packages, pull requests, commits, and local files before changing code. |
Semantic navigation | Resolve definitions, references, callers/callees, call hierarchy, hovers, symbols, diagnostics, and type relationships through LSP. |
Structural matching | Run AST-shaped searches with patterns or YAML rules so comments and strings do not become false positives. |
Large-file context | Minify, skeletonize, or paginate code so agents spend tokens on relevant structure instead of boilerplate. |
Agent workflows | Same engine through MCP, CLI, and Agent Skills. |
Built for research (benchmarks)
A blind, head-to-head test on research-oriented flows rather than plain lookups (multi-hop traces, dependency/call-graph chains, commit ranges, blast-radius, PR reviews across repositories).

How it works: 30 GitHub questions × 3 passes; Octocode vs gh, gh+Headroom, and gh+RTK on
identical questions (only the CLI differs). A blind judge (gpt-5.5) grades correctness; the metric is
characters through the model, counted from instrumented logs (characters, not tokens). Result: at
near-parity correctness, Octocode answers with ~2.0× fewer characters than plain gh, ~2.6× fewer
than gh+Headroom, and ~3.2× fewer than gh+RTK in the local-build headline runs.
▶ Open the interactive report · run it / method · questions · all reports
Tools
17 tools in the full catalog. How many register depends on the surface and the flags you set:
Surface | Registers | What that set is |
MCP, no flags | 8 | GitHub search and read, plus |
MCP, | 14 | Adds the five local tools and |
MCP, | 15 | Adds |
MCP, | 17 | Adds |
CLI, no flags | 15 | Local tools and clone are on by default |
CLI, | 17 | Adds the same two GitHub tools |
ghListReleases and ghSearchDiscussions need two settings on MCP, not one:
ENABLE_RELEASES=1 or ENABLE_DISCUSSIONS=1 puts the tool in the catalog, and
ENABLE_TOOLS="ghListReleases,ghSearchDiscussions" registers it. Either setting
alone leaves the tool unregistered, because both carry isDefault: false and the
MCP registration filter admits only default or explicitly allowlisted tools. The
CLI needs only the ENABLE_RELEASES and ENABLE_DISCUSSIONS flags. ENABLE_LOCAL
and ENABLE_CLONE accept true or 1; ENABLE_RELEASES and ENABLE_DISCUSSIONS
also accept yes and on.
Flags: Configuration.
Token knobs. concise:true returns path/title-only lists. minify controls file read density: symbols = skeleton with line numbers, standard = comments/blanks stripped (default), none = exact bytes.
GitHub tools
Tool | What it does | Knob |
| Code and path search across GitHub by owner, repository, path, filename, extension, and match filters. Accepts 1 to 5 parallel queries. |
|
| Read a GitHub file or region: full file, line range, match slice, or paginated chars. |
|
| Browse a repository's directory tree, plus opt-in repository enrichments. |
|
| Discover repositories by keywords, owner, topic, language, stars, updated, license, visibility. |
|
| Search pull requests, or deep-read one PR: files, patches, comments, reviews, commits. |
|
| Search issues, or read one issue's body and comments. |
|
| Walk a repository's commit history, or compare two refs ( |
|
| List releases and the latest stable release, with opt-in assets. Opt-in (see Tools for the flags). |
|
| Search a repository's Discussions (Q&A, RFCs, announcements) through GraphQL. Opt-in (see Tools for the flags). |
|
| Clone a repository or sparse subtree into the local cache for local and LSP analysis. Opt-in on MCP ( |
|
Local tools
Tool | What it does | Knob |
| Local code/text search returning file and line anchors. |
|
| Browse a local directory tree: depth, filters, pagination, metadata. |
|
| Find local files and directories by name, path, regex, extension, size, time, permissions, type. | |
| Find likely-unreferenced exports and dead-code clusters using whole-repository reachability analysis. |
|
| Read a local file or region: exact slice, match string, line range, or paginated chars. |
|
Package search
Tool | What it does | Knob |
| npm package lookup and keyword search; returns metadata and the source repository for GitHub handoff. |
|
LSP
Tool | What it does |
| Typed semantic navigation: |
Full schemas, fields, and examples for every tool live in docs/OCTOCODE_TOOLS.md (linked under Documentation).
MCP
The MCP server exposes the Octocode tool catalog directly to your AI assistant over stdio.
https://github.com/user-attachments/assets/de8d14c0-2ead-46ed-895e-09144c9b5071
Manual configuration
Add to your MCP client config, using octocode-mcp:
{
"octocode": {
"command": "npx",
"type": "stdio",
"args": [
"octocode-mcp@latest"
]
}
}Add a GitHub token and options under env - see Authentication and Configuration.
CLI
Same research engine, no MCP client needed. Local paths route to local tools; owner/repo[/path] routes to GitHub. Authenticate once with npx octocode auth login (see Authentication); run npx octocode --help for full usage.
Commands
Tool commands
Command | What it does |
| Show one tool's schema: fields, types, bounds, defaults |
| Run a tool (same tools as MCP), YAML output |
| Run a tool, full |
| List every available tool |
More commands
Cache and clone —
npx octocode clone,npx octocode cache fetch|status|clearSkills —
npx octocode skill list|install|check|info|removefor bundled Octocode skillsLanguage servers —
npx octocode lsp-server list|install|status|uninstall|cleanSetup and introspection —
npx octocode install,npx octocode auth,npx octocode status,npx octocode context
Full syntax, flags, and exit codes: Octocode CLI guide
Configuration
Everything is optional; Octocode runs on sensible defaults. Settings resolve from three sources, in priority order:
environment variables > <octocode-home>/.octocoderc > built-in defaultsMCP / environment variables (highest): per client or per project, set in your MCP config
envor your shell.Global config:
<octocode-home>/.octocoderc, machine-wide defaults read by both the CLI and the MCP server.Built-in defaults: used when neither is set.
Octocode home (<octocode-home>) holds the global config, encrypted credentials, sessions, stats, and tmp materialization caches. On every platform it is .octocode inside the OS home directory — ~/.octocode on macOS and Linux, %USERPROFILE%\.octocode on Windows. Override it with OCTOCODE_HOME.
Set values as MCP env entries (per client; these win over .octocoderc) or globally in <octocode-home>/.octocoderc (JSON with comments). Tokens never go in .octocoderc — use env or npx octocode auth login.
Common settings
Most-used settings (both CLI and MCP unless noted):
Env var |
| Default | What it does |
| env only | unset | GitHub token, in priority order. Never in |
|
| CLI | Local filesystem and LSP tools on or off. |
|
| CLI |
|
|
|
| Root for resolving relative local paths. |
|
|
| Extra path allowlist for local access. |
|
|
| Response format: |
OCTOCODE_HOME, GitHub Enterprise (GITHUB_API_URL), MCP tool allowlisting (TOOLS_TO_RUN/ENABLE_TOOLS/DISABLE_TOOLS), and network timeouts/retries: see the Configuration Reference.
Example configuration
~/.octocode/.octocoderc:
{
"github": {
"apiUrl": "https://api.github.com"
},
"local": {
"enabled": true,
"enableClone": true
},
"output": {
"format": "yaml"
}
}Per-project overrides and custom LSP servers live in a workspace .octocode/ folder. For the full .octocoderc schema, a ready-to-copy example, clone-cache tuning, GitHub Enterprise setup, and precedence details, see the Configuration Reference.
Authentication methods
GitHub-backed tools require authentication. Any one method is enough. Full details: Authentication Setup.
Option 1: Octocode CLI (recommended)
npx octocode auth login
npx octocode status # verify the active token sourceInteractive login lets you choose Octocode browser OAuth or gh auth login. Octocode OAuth credentials are stored encrypted on disk.
Option 2: GitHub CLI (also supported)
gh auth loginOctocode reads the gh token automatically — no further config needed.
Option 3: Personal access token (also supported)
Set OCTOCODE_TOKEN, GH_TOKEN, or GITHUB_TOKEN in your shell. Required scopes: repo, read:user, read:org.
Create a token at github.com/settings/tokens.
Note: Never commit tokens to version control. Use environment variables or secure secret management.
Security
Every byte to the model is scanned and redacted first. All content passes through the Rust engine's secret scanner on the way in and out, so secrets never reach the model. That covers local files, GitHub and npm responses, errors, and tool output. The behavior is identical under MCP and the CLI.
Secret redaction, in and out. 300+ provider credential patterns (AWS, Azure, GCP, GitHub, OpenAI, Anthropic, Stripe, Slack, 1Password, and more) plus generic JWTs, PEM/private keys, bearer tokens, database connection strings, and high-entropy strings. Masked values surface a redaction warning so the agent knows.
Content sanitized at the source. Local reads (
localGetFileContent, ripgrep, structural search, binary, file discovery, structure) and external fetches (GitHub code/files, npm) are scanned as they are read, not only at the boundary.Path safety. Relative inputs resolve from
WORKSPACE_ROOT/ config /cwd, then local reads are bounded to the engine's allowed roots (home by default, plusALLOWED_PATHSand Octocode-registered roots). Symlinks are resolved and the real target is re-validated, so a link cannot escape into a blocked location.Sensitive files blocked by default. Reads of known secret-bearing files and folders return a redacted error instead of contents: keys/certs,
.env*,.npmrc/.netrc, cloud/infra credentials (.aws/,.kube/,*.tfstate),.git/, browser logins, OS keychains, and wallets. Full list in SECURITY.md.Command safety. Normal local search runs in-process inside
octocode-engine. External helpers are fixed per lane, command/argument allowlisted, and run throughspawnwith argument arrays: no shell strings, no injection.Schema validation runs before any tool executes; untrusted input size and shape are bounded.
Credentials. GitHub auth through env tokens, AES-256-GCM-encrypted on-disk OAuth, or the
ghCLI; tokens are never logged.
Full security model, pipeline, and threat coverage: SECURITY.md. Related: Configuration and authentication · Credentials
Language support
Four code-intelligence axes; three are native to the Rust engine and need no external tooling:
Axis | What it does | How to use it |
Structural AST | Tree-sitter shape queries ( |
|
Signature outline | Body-free skeleton with line numbers from real tree-sitter parsing, no heuristics. An anti-growth guard returns the real file when a skeleton is not smaller. |
|
Content minification | Comment/whitespace stripping for 70+ languages and config formats; HTML/Vue/Svelte also minify embedded |
|
LSP navigation | definition, references, callers/callees, callHierarchy, hover, typeDefinition, implementation, documentSymbols, through an installed language server; JS/TS also have a native, no-server path. |
|
📋 Full support matrix: every extension with its exact AST, signature, LSP, and minify capability lives in the Full format support matrix.
Skills
Agent Skills are a lightweight, open format for extending AI agent capabilities. Browse and install on skills.sh/bgauryy/octocode-mcp
13 skills under skills/, bundled in the octocode package. Each is a lean SKILL.md that loads references only when needed, so they compose. Start with ⭐ Research for evidence-first code work.
npx octocode skill list
npx octocode skill install octocode-research --platform pi
npx octocode skill check --json
npx octocode skill helpCore research and extraction
Skill | Use when |
Evidence-first research, review, debugging, refactors, prior-art validation. | |
Public page extraction and crawl triage: static corpus + graph v2 (pages/data/actions/risks/evidence), then CDP handoff for dynamic actions and blocked pages. | |
Browser/CDP evidence: network, console, performance, cookies/storage, screenshots, auth-gated pages, and live validation of scrape-graph actions. |
Planning and architecture
Skill | Use when |
Disciplined idea exploration before building: options, worth-building tests, prior-art maps. | |
Evidence-backed RFCs, design docs, migration plans, option comparisons. | |
Writing or updating README, API docs, runbooks, AGENTS.md, ADRs. |
Evaluation and review
Skill | Use when |
Blunt, evidence-backed code critique with severity ranking and repair paths. | |
Measuring whether a change helped: goal→KPI contracts, baselines, accept/revert loops, eval suites. | |
Making prompts, tool schemas, and agent contracts clearer, safer, cheaper, measurable. |
Agent orchestration
Skill | Use when |
Spawning workers / Task / A2A / challenge techniques, or offloading token-heavy text to local Ollama under a verify gate. | |
Agent-skill lifecycle: discover, review, create, improve, install, sync. |
Web automation workflow: octocode-scraping performs the safe static pass first (fetch/crawl/extract → local corpus → graph v2). When the graph exposes dynamic actions or static output is blocked/thin, octocode-chrome-devtools validates live actionability, cookies/storage, network/HAR bodies, screenshots, or auth-gated state; discovered URLs/data/artifacts can be fed back into the scraping corpus for continued proof.
Architecture
A yarn-workspaces monorepo. The MCP server and the CLI are thin front-ends over one shared TypeScript tool core, which delegates every CPU-heavy path to a single Rust engine (compiled through napi-rs to prebuilt .node binaries). One tool catalog, one security layer, one response shaper, reached two ways.
graph LR
CLI["octocode<br/>CLI"]
MCP["octocode-mcp<br/>MCP server, stdio"]
VSC["VS Code extension<br/>OAuth + install"]
CORE["octocode-tools-core<br/>tools, GitHub client, auth, pagination, security bridge"]
ENGINE["octocode-engine (Rust)<br/>secrets, minify, AST, signatures, ripgrep/diff/YAML, LSP"]
EXT["GitHub API, local FS + ripgrep, language servers"]
CLI --> CORE
MCP --> CORE
VSC -. starts .-> MCP
CORE --> ENGINE
CORE --> EXT
ENGINE --> EXT
style ENGINE fill:#1a1a2e,stroke:#e75d2a,color:#fffRequest flow is identical whether a call arrives over MCP or the CLI:
client → sanitize inputs (Rust) → run tool (GitHub / FS / LSP) → sanitize + YAML-serialize + paginate (Rust) → result + next-step hintsOne Rust engine owns secret detection, sanitization, path and command validation, minification (70+ languages), signature extraction, structural AST search, ripgrep parsing, diff filtering, YAML serialization, and LSP. The Node event loop therefore stays unblocked, and there is no duplicate native loader. The engine ships prebuilt for darwin (arm64/x64), linux (arm64/x64, gnu and musl), and win32-x64; no Rust toolchain is needed at runtime.
Packages
Directory | npm package | Role |
| CLI: quick commands, raw tool runner, skill installs, auth/login/logout, install, status, context. | |
| MCP server (stdio) that registers the tool catalog for AI assistants. | |
| Shared tool core: implementations, GitHub client, credentials and token resolution, session, pagination, security bridge. | |
| Rust/napi native engine: security scanning, minification, signatures, structural AST, ripgrep/diff/YAML, LSP. | |
| Zero-dep env + config loader: | |
| VS Code extension: GitHub OAuth + multi-editor MCP install. |
packages/octocode-benchmark (private, not published) holds benchmark methodology, evals, and run artifacts - see Documentation.
Documentation
Website: octocode.ai · Product docs: github.com/bgauryy/octocode/tree/main/docs. This section is the canonical documentation index; benchmark methodology, evals, and run artifacts live in packages/octocode-benchmark.
Area | Docs |
MCP server | |
Tools and workflows | Octocode tools reference · RDD manifest and workflows · Octocode research skill |
CLI | |
Research model | Octocode research manifest · Routing and evidence position paper · MCP tool quality and agent workflow |
Skills | |
Development and security | |
Benchmarks and evals | Benchmark results · Benchmark design · Benchmark runbook · Support matrix |
Shared internals |
Troubleshooting
Node.js or environment issues? Run the built-in doctor command to check your environment:
npx node-doctorCommon pitfalls:
GitHub auth failures: Ensure your Personal Access Token (PAT) has the
repoandread:userscopes. If using the CLI, runnpx octocode auth loginto refresh.MCP connection issues: If your AI assistant (like Cursor or Windsurf) fails to connect, ensure you have run
npx octocode auth loginin your terminal first, or explicitly pass yourOCTOCODE_TOKENin the MCPenvconfiguration.Native engine errors: Octocode uses a prebuilt Rust engine. If it fails to load on Linux, ensure your system has
glibcormuslcompatibility. On macOS/Windows, ensure you are on a supported architecture (x64 or arm64).
Agent workflows
Recommended dev mode: Pi + Octocode
Pi is a fast, local-first coding agent whose stated philosophy is "CLI tools with READMEs (Skills) over MCP." Pairing it with Octocode gives a lean, evidence-driven dev loop — Pi edits, Octocode researches. Two routes, pick by how much surface you need:
Skill route — recommended, leanest. Drop the
octocode-researchskill into Pi's global skills dir. It drives the Octocode CLI directly — no MCP transport, minimal token overhead — and Pi auto-discovers it:npx octocode skill install octocode-research --platform piAdapter route — full tool surface. Install
pi-mcp-adapterto expose Octocode MCP tools behind a single ~200-token proxy tool, so servers stay disconnected until a tool is called. Enable clone tools withENABLE_CLONE=true.
Research-driven loop
Most agent failures happen before the edit: guessing who owns a behavior, trusting a snippet without reading the source, editing before proving blast radius. Run a cheaper loop instead: orient with trees, search, read exact evidence, use AST/LSP when identity matters, then patch and verify. The host edits, Octocode is the map, and skills encode the habit.
The Manifest
"Code is Truth, but Context is the Map." Read the Manifest of Octocode for Research Driven Development to understand the philosophy behind Octocode.
Available Tools
13 toolsgithubGetFileContentAIdempotent
Read GitHub file or download directory [EXTERNAL: GitHub API]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for githubGetFileContent (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds significant behavioral details beyond annotations: file returns content inline, directory saves to disk and returns localPath. It discloses limits (300KB max, branch naming), input constraints (mutually exclusive params), and mode-specific behaviors. No contradiction with annotations (idempotentHint=true, destructiveHint=false).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description uses a well-organized structure with headings (<when>, <fromTool>, etc.) that front-load the main purpose and allow quick scanning. While lengthy due to necessary detail (gotchas, examples), every section adds value and the conciseness is appropriate for the complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers all aspects for effective use: when to use, how to use (modes, params), pitfalls (gotchas), examples, and integration with siblings. It mentions prerequisites for directory mode (ENABLE_LOCAL, ENABLE_CLONE) and the file size limit. The output schema exists separately, so return values are omitted by design.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already has 100% description coverage, but the description adds value by explaining the three mutually exclusive file modes (matchString, startLine+endLine, fullContent) and the pagination parameters (charOffset, charLength) in the <gotchas> and <modes> sections, enhancing practical usage understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reads a GitHub file or downloads a directory, with specific verbs ('read', 'download') and resource ('GitHub file or directory'). It distinguishes from siblings like githubSearchCode (search) and githubViewRepoStructure (structure), and the title 'GitHub File Content Fetch' reinforces the purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> section provides clear contexts (e.g., read from known path, download directory). The <fromTool> and <toTool> sections guide use in conjunction with other tools. However, it lacks explicit 'when not to use' guidance, though the modes and gotchas imply exclusions (e.g., directory mode requires specific flags).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
githubSearchCodeARead-onlyIdempotent
Search GitHub code [EXTERNAL: GitHub API]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for githubSearchCode (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds substantial behavioral detail beyond annotations, including strict prefix matching for 'path', pagination parameters, match type behavior, and filtering constraints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>). It is front-loaded with essential usage context, though some redundancy exists (e.g., repeating 'match' behavior in multiple places).
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity with nested queries and multiple parameters, the description is remarkably complete. It covers when to use, how to chain with other tools, gotchas, and examples. The presence of an output schema reduces the need to explain return values.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema covers all parameters with descriptions, and schema coverage is 100%. The description enriches parameter understanding with contextual advice like 'Start lean: single filter -> verify -> add filters' and explicit examples, adding meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool searches GitHub code, with explicit directives to 'Find code patterns' and 'Locate files by path'. It distinguishes between match=file and match=path, and mentions cross-repo usage. Sibling tools like githubSearchRepositories and githubGetFileContent are differentiated through usage guidance.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> section defines appropriate contexts, and <fromTool> and <toTool> sections provide explicit sequencing with sibling tools. The <gotchas> section offers critical do's and don'ts, such as avoiding combining extension+filename+path and preferring owner+repo for precision.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
githubSearchPullRequestsARead-onlyIdempotent
Search GitHub Pull Requests [EXTERNAL: GitHub API]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for githubSearchPullRequests (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds critical behavioral details in the <gotchas> section, such as 'prNumber ignores ALL other filters' and 'Avoid fullContent on large PRs (token expensive)', which go beyond annotations. No contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>) and is front-loaded with the title and external API note. While comprehensive, it is relatively long, but each section earns its place given the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (many parameters, nested query objects, relationships to siblings) and the presence of an output schema (not shown), the description covers usage patterns, gotchas, and integration with other tools comprehensively. It provides enough context for an agent to use it effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed descriptions for each parameter, so baseline is 3. The description adds value through concrete examples showing parameter combinations and the gotcha about prNumber. However, the description does not elaborate on parameter semantics beyond what the schema already provides, so it does not fully compensate for the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Search GitHub Pull Requests'. The <when> section provides specific use cases like code archaeology and implementation history, and the fromTool/toTool sections differentiate it from sibling tools by showing how they relate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> section explicitly outlines when to use this tool (code archaeology, implementation history) and suggests a workflow (metadata first, then partialContent). The fromTool and toTool sections provide clear guidance on alternatives and sequencing, e.g., using githubSearchCode first, then this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
githubSearchRepositoriesARead-onlyIdempotent
Search GitHub repositories [EXTERNAL: GitHub API]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for githubSearchRepositories (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=true. The description adds valuable behavioral context: gotchas like pushedAt vs updatedAt distinction, stars filter noise, archived auto-exclusion, and synonym suggestions. Adds significant value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately long but well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>). Every section adds value and the front-loading of purpose is good. Slightly verbose but acceptable given complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of the tool (multiple query parameters, pagination, interaction with other tools), the description is complete. It covers usage context, tool flow, gotchas, and examples. Output schema exists, so return values are not needed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed parameter descriptions (e.g., stars filter format, match enum). The description itself doesn't add much beyond schema for individual parameters but provides examples that illustrate usage. Baseline 3 is appropriate as schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Search GitHub repositories' and distinguishes from sibling tools like packageSearch (faster for known packages) and githubSearchCode (code search). The purpose is specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes explicit <when> usage context (external research, finding repos) and <fromTool>/<toTool> sections that guide the flow between tools. It also names alternatives like packageSearch for known packages, providing clear when-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
githubViewRepoStructureARead-onlyIdempotent
Display GitHub repo structure [EXTERNAL: GitHub API]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for githubViewRepoStructure (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds crucial behavioral details in '<gotchas>': depth=2 slowdown, auto-filtering of noisy dirs (e.g., .git, node_modules), maximum 200 items, and the need to check summary.truncated. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>) that are front-loaded and efficient. Every sentence provides actionable information with no redundancy, making it easy for an agent to parse and apply.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity, output schema existence, and full schema coverage, the description covers all necessary aspects: use cases, workflow, gotchas, examples, and tool interactions. It leaves no critical gaps for an agent to select and invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds value through examples (e.g., path='', depth=1; path='src', depth=2) and gotchas that clarify parameter usage (starting from root, depth constraints). While not exhaustive, it enhances understanding beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Display GitHub repo structure' and positions it as an entry point for understanding layout and discovering paths. It explicitly distinguishes from sibling tools like githubSearchCode and githubGetFileContent via the 'toTool' section, ensuring no ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit <when> section describing use cases (Understand layout, Discover paths, Entry point) and a workflow (Root depth=1, then Drill path+depth=2). Also includes 'fromTool' and 'toTool' sections that guide the agent on tool chaining, offering clear when-to-use and when-to-alternate guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
localFindFilesARead-onlyIdempotent
Find files by metadata [LOCAL: filesystem]
Config/docs: localGetFileContent directly
Faster than content search (metadata indexing)
excludeDir for noise (node_modules, dist, .git)
Time: '7d', '2h', '30m'
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for localFindFiles (1–5 per call). Review schema before use. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, destructiveHint, and idempotentHint. The description adds valuable behavioral context: performance note ('Faster than content search due to metadata indexing'), default exclusion directories, time format examples, and pagination details (filesPerPage, charOffset). No contradictions with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (when, fromTool, toTool, gotchas, examples) and front-loads the core purpose. However, it is relatively verbose; could be more concise by removing redundant phrases. Still easily scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (many parameters and pagination), the description provides comprehensive context: usage workflow, examples, performance characteristics, and exclusion defaults. An output schema exists, so return value explanation is not needed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with individual parameter descriptions. The description enhances understanding via examples (e.g., time formats '7d', '2h') and gotchas (e.g., excludeDir defaults), but does not add new meaning for each parameter beyond what schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool finds files by metadata (name, time, size, permissions) on the local filesystem. It explicitly distinguishes from sibling tools: 'NOT for content - use localSearchCode' and fromTool section links to localViewStructure, making differentiation unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> section provides explicit guidance on when to use (metadata search, scope narrowing, recent changes) and when not to (content search, directing to localSearchCode). The <fromTool> and <toTool> sections further specify workflow ordering with other tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
localGetFileContentARead-onlyIdempotent
Read file content [LOCAL: filesystem]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for localGetFileContent (1–5 per call). Review schema before use. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds significant behavioral context beyond annotations, such as the ability to read specific lines, match patterns, pagination via charOffset/charLength, and token efficiency warnings for large files. There is no contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (<when>, <gotchas>, <examples>) that are front-loaded. Despite length, every section earns its place by providing essential context, guidelines, or examples. No redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (multiple parameters, pagination, batch queries) and the presence of annotations and output schema, the description is complete. It covers when to use, how to use, pitfalls, examples, and alternatives, leaving no ambiguity for the agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds value beyond the schema through examples and gotchas that illustrate parameter combinations (e.g., using startLine/endLine for known ranges, fullContent for small configs). It clarifies pagination parameters and the batch nature of queries, which enhances understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Read file content [LOCAL: filesystem]' and lists specific use cases in the <when> section, such as reading implementation after locating with search/LSP and reading configs/docs directly. It also distinguishes from sibling tools by stating 'Direct read OK for: configs, docs, .json, .md, .yaml' and providing alternatives like LSP tools for certain tasks.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides extensive usage guidelines through sections like <when>, <fromTool>, <flow_questions>, and <gotchas>. It explicitly tells when to use the tool, when to prefer alternatives (e.g., LSP tools for flow analysis), and best practices (e.g., use matchString for large files, startLine/endLine for known ranges).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
localSearchCodeARead-onlyIdempotent
Search code patterns [LOCAL: ripgrep] - START HERE for code questions
Without LSP:
localGetFileContent(matchString) for context
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for localSearchCode (1–5 per call). Review schema before use. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only, non-destructive, idempotent behavior. The description adds gotchas like lineHint being 1-indexed, filesOnly for fast discovery, and type filter efficiency, providing additional behavioral context beyond annotations. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>), front-loaded with a summary. Each section is concise and serves a distinct purpose without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (many parameters) and the presence of an output schema, the description provides sufficient context with examples, workflows, and gotchas. It covers usage beyond the schema, making it complete for an agent to use effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are well-documented. The description adds value through examples and gotchas (e.g., filesOnly, type filter), but does not elaborate on each parameter since the schema already does. Baseline 3 is elevated to 4 due to practical usage tips.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it searches code patterns using ripgrep, listing specific use cases like function finding, symbol lookup, and pattern matching. It distinguishes from sibling tools like localFindFiles and localViewStructure by referencing them in the <fromTool> and <toTool> sections.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> and <toTool> sections provide explicit guidance on when to use this tool and how it fits into workflows with LSP or alternative tools (e.g., lspGotoDefinition, lspFindReferences). It also suggests self-refining patterns.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
localViewStructureARead-onlyIdempotent
View directory structure [LOCAL: filesystem]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for localViewStructure (1–5 per call). Review schema before use. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, destructiveHint, and idempotentHint. The description adds valuable behavioral context: auto-excludes (node_modules, .git, dist), performance warnings (depth=2 slow on large dirs), and pagination behavior. This goes beyond annotations without contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (<when>, <fromTool>, <toTool>, <gotchas>, <examples>). It is front-loaded with the core action and usage context. While comprehensive, it remains concise and each section earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (local filesystem, many parameters, sibling tools) and the existence of an output schema, the description covers all necessary contexts: usage scenarios, workflow guidance, pitfalls, sibling differentiation, and examples. It is fully complete for AI agent understanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description mentions key parameters (path, depth, pattern, filesOnly) in examples and gotchas but does not add significant semantic detail beyond what the schema descriptions provide. Some parameters like 'charOffset' have empty descriptions in schema, but the description does not address them.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'View directory structure' and provides explicit examples and usage patterns. It distinguishes itself from siblings by outlining when to use this tool versus localFindFiles, localSearchCode, etc., making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> block explicitly describes when to use the tool, including workflow steps (start depth=1, drill depth=2, then search). It also contrasts with sibling tools in <fromTool> and provides situational advice like monorepo checks.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lspCallHierarchyARead-onlyIdempotent
Trace function call relationships [LOCAL: LSP]
REQUIRES lineHint - call localSearchCode FIRST to get line number
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for lspCallHierarchy (1-3 per call). Review schema before use. Expensive operation; prefer depth=1 and follow up from returned calls. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true. Description adds useful context: requires lineHint (1-indexed), works cross-file, traces imports automatically, and is semantic. No contradictions. Could mention cost/expense in description itself, but schema covers that.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is lengthy but well-structured with clear sections (when, prerequisite, fromTool, etc.) and front-loaded purpose. Every section adds value, but could be slightly more concise without losing clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity and the presence of output schema, the description covers all necessary aspects: prerequisites, alternatives, flow patterns, gotchas, and examples. No gaps in understanding how the tool works or how to use it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed descriptions for each parameter. The description adds examples and usage patterns but does not significantly enhance parameter semantics beyond what the schema already provides, meeting the baseline of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states 'Trace function call relationships [LOCAL: LSP]' and distinguishes between incoming/outgoing directions. It also includes a dedicated section comparing with sibling lspFindReferences, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit when-to-use scenarios via <when> tags (e.g., 'Who calls this?' for incoming), prerequisite requirements (lineHint from localSearchCode), and alternatives (lspFindReferences for non-call usages). Also includes flow patterns and examples.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lspFindReferencesARead-onlyIdempotent
Find all usages of a symbol [LOCAL: LSP]
REQUIRES lineHint - call localSearchCode FIRST to get line number
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for lspFindReferences (1-5 per call). Review schema before use. Batch independent symbols and use page for large result sets. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already specify readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds useful behavioral details such as the requirement for lineHint, case-sensitivity of symbolName, and that includeDeclaration defaults to true, but does not contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections, bullet points, and examples. It is somewhat lengthy but each section is informative and front-loaded with the core purpose, making it easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity with multiple parameters and nested queries, the description covers prerequisites, common pitfalls, integration with other tools, and provides examples. An output schema exists, so return values are not required. The description is complete and actionable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed descriptions for each parameter. The description adds value by highlighting critical constraints like 'lineHint required (1-indexed)' and providing examples, enhancing understanding beyond the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Find all usages of a symbol' and provides examples like 'Where is X used?'. It distinguishes itself from siblings like lspCallHierarchy, which focuses on call relationships.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes explicit <when> section, prerequisites from localSearchCode, <fromTool> and <toTool> dependencies, and a comparison with lspCallHierarchy, providing comprehensive guidance on when to use this tool vs alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lspGotoDefinitionARead-onlyIdempotent
Navigate to symbol definition [LOCAL: LSP]
REQUIRES lineHint - call localSearchCode FIRST to get line number
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Queries for lspGotoDefinition (1-5 per call). Review schema before use. Batch independent symbol lookups. | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false. The description adds behavioral details: requires lineHint (1-indexed from localSearchCode), symbolName must be exact, tool searches +/-2 lines, batching support (1-5 per call), and pagination parameters. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with markdown sections, front-loaded with purpose. Every section (when, prerequisite, fromTool, toTool, gotchas, examples) provides essential information without redundancy. Concise yet comprehensive.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given output schema exists, return values need no explanation. The description covers prerequisites, gotchas, relationships with siblings, and examples. For a tool with complex parameter dependencies and batching, this is complete and self-contained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% description coverage, so baseline is 3. The description adds value by explaining cross-tool dependencies (lineHint from localSearchCode), exactness of symbolName, and default values for orderHint/contextLines, which helps the agent construct correct parameters beyond schema definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Navigate to symbol definition' with specific verb and resource. The <when> section delineates exact use cases (find definition, trace import) and the <fromTool>/<toTool> sections distinguish this from siblings like lspFindReferences and lspCallHierarchy.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit <when> and <prerequisite> sections state when to use and that lineHint from localSearchCode is required. The <toTool> section lists alternatives (e.g., lspFindReferences for usages) and <gotchas> note when to fall back to external search (packageSearch -> githubGetFileContent).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
packageSearchARead-onlyIdempotent
Find NPM/Python packages [EXTERNAL: npm/PyPI]
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | Research queries for packageSearch (1-3 queries per call for optimal resource management). Review schema before use for optimal results | |
| responseCharOffset | No | Character offset for top-level bulk response pagination across results[]. Use when a multi-query response was auto-paginated. | |
| responseCharLength | No | Character budget for top-level bulk response pagination across results[]. Overrides the shared default for this call. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | Array of results, one per input query, discriminated by status |
| responsePagination | No | Pagination metadata for top-level bulk response pagination across results[] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds critical behavioral details: searchLimit defaults (1 for known, 5 for alternatives), Python returns only 1 result, naming conventions (dashes vs underscores), and the need to check deprecation warnings. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (titles, when, fromTool, toTool, vsGitHub, gotchas, examples). It is comprehensive without being overly verbose. Slightly more concise could be achieved, but it is appropriate for the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of the tool (multi-parameter array, two ecosystems), the description covers all essential aspects: external APIs, behavior differences, pagination, deprecation, and integration with sibling tools. The schema and output schema handle the rest, leaving no gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed property descriptions. The description adds value through <gotchas> (e.g., Python always returns 1, naming conventions) and <examples> (concrete usage of name and ecosystem). This exceeds the baseline but not by a large margin.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Title and description clearly state 'Find NPM/Python packages' and specify that it provides repository URLs. The <vsGitHub> section explicitly distinguishes from githubSearchRepositories, making the purpose specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The <when> section lists clear use cases: lookup by name, get repo URL, compare alternatives, check deprecation. The <fromTool> and <toTool> sections provide chaining guidance, and <vsGitHub> advises using this tool first for known names versus githubSearchRepositories for broad discovery.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
TDQS
Each tool targets a distinct operation: GitHub tools for remote repo actions (get file, search code, search PRs, search repos, view structure), local tools for filesystem actions (find files, get file content, search code, view structure), LSP tools for semantic analysis (goto definition, find references, call hierarchy), and a separate package search tool. There is no overlap in purpose.
All tool names follow a consistent camelCase pattern with a prefix indicating domain (github, local, lsp) followed by a verb-noun combination (e.g., githubGetFileContent, localSearchCode, lspGotoDefinition). The naming is predictable and intuitive.
13 tools is well-scoped for a server that combines GitHub API exploration (5 tools), local filesystem analysis (4 tools), LSP-based code navigation (3 tools), and package search (1 tool). Each tool serves a clear purpose and contributes to the overall functionality without bloat.
The tool set covers the complete lifecycle for code exploration and analysis: discovery (search repos, view structure, find files), content access (get file content, search code), semantic navigation (goto definition, find references, call hierarchy), and package lookup. There are no obvious gaps for the server's stated purpose.
Maintenance
Related MCP Connectors
Code intelligence for LLMs. Analyze, search, and retrieve code from any public git repository.
Provide AI-powered real-time analysis and intelligence on NPM packages, including security, depend…
Code intelligence for coding agents: semantic, AST, graph, and full-text search. 279+ languages.
Code intelligence platform for AI agents. 20 tools for architecture, security & impact analysis.
Related MCP Servers
- AlicenseCqualityDmaintenanceA free, open-source service that transforms GitHub projects into MCP endpoints, enabling AI assistants to access and understand project documentation without any setup.32988,364Apache 2.0
- AlicenseNot gradedqualityDmaintenanceEnables semantic code search across multiple repositories using natural language queries. Provides intelligent code discovery, symbol lookups, and cross-repo dependency analysis for AI coding agents.MIT
- AlicenseAqualityFmaintenanceProvides code repository indexing and semantic search capabilities, allowing natural language queries to find relevant code snippets with automatic incremental indexing and multi-language support.119360ISC
- AlicenseAqualityAmaintenanceA local-first codebase intelligence tool that enables AI assistants to research codebases using semantic search, multi-hop relationship discovery, and structural parsing. It allows users to extract architectural patterns and institutional knowledge across 30+ programming languages through an MCP-compatible interface.21,415MIT
Appeared in Searches
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/bgauryy/octocode'
If you have feedback or need assistance with the MCP directory API, please join our Discord server