graph.index

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

The description mentions parsing and saving, implying mutation, but does not disclose whether existing symbols are overwritten or appended, error conditions, or authorization needs. With no annotations, the description bears full responsibility but falls short.

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 a single sentence that conveys the core purpose without unnecessary words. However, it could be slightly more structured to include guidance or parameter hints.

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 is minimal for a tool with two parameters and an output schema. It does not explain what the output schema contains, side effects, or how it relates to sibling tools, leaving gaps 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?

The description only clarifies the 'path' parameter by mentioning 'file path'. The 'languages' parameter is not explained at all, and no valid values or default behavior are described. Given 0% schema coverage, more detail is needed.

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 action: parsing a file path and saving extracted symbols to a symbols table. It uses specific verbs and nouns (parse, saves, extracted symbols) and distinguishes itself from sibling tools like graph.get_symbol or graph.trace_calls by focusing on indexing.

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?

No guidance is provided on when to use this tool versus alternatives. It does not specify prerequisites, limitations, or contexts where it is appropriate, leaving the agent without decision support.

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