Skip to main content
Glama

docs_for_symbol

Retrieve documentation for a code symbol, including markdown chunks and doc comments, prioritizing local context before broader documentation.

Instructions

Find documentation related to a symbol — markdown chunks and doc comments, preferring local context before broad docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
refNo
limitNo
symbolNo
includeNoWhat to include: `memories` (on by default); `references`, `unresolved`, `macros`, `common_methods`, `coverage` (all off by default). Omit to keep defaults; an explicit list is the exact on-set (so listing `macros` alone also drops the default `memories`).
worktreeNoAbsolute path to a linked git worktree you're working in; serves that worktree's branch overlay over the indexed checkout. Omit (or pass an unrelated path) for the indexed checkout.
edge_kindsNo
resolutionNo
allow_ambiguousNo
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It mentions a preference for local context but does not disclose side effects, permissions, or whether it is read-only. The behavioral disclosure is minimal.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise, consisting of a single sentence that front-loads the purpose. However, it could be improved with structured sections for clarity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 9 parameters, no output schema, and no annotations, the description is grossly incomplete. It does not explain behavior, output format, error conditions, or parameter usage, leaving significant gaps for the agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 22% schema description coverage and a 9-parameter schema, the description adds no parameter information. It fails to explain how to specify the symbol or use other critical parameters like 'ref', 'id', or 'allow_ambiguous'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool finds documentation for a symbol, specifying it looks for markdown chunks and doc comments. However, it does not differentiate from sibling tools like 'memory_for_symbol' or 'symbol_lookup', which reduces clarity in context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives. The description lacks explicit when-to-use or when-not-to-use conditions, leaving the agent to infer without context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

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/cq27-dev/rag-rat'

If you have feedback or need assistance with the MCP directory API, please join our Discord server