codebase_context_index

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

No annotations provided; description states it indexes, chunks, and embeds, but lacks details on whether it is destructive, idempotent, or has side effects. Basic behavior is clear but not deeply transparent.

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?

Three concise sentences, front-loaded with action, no unnecessary words. Perfectly structured.

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?

With no output schema, the description covers purpose, behavior, and usage guidance adequately for a simple tool. Minor omission of potential side effects, but enough for practical use.

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 the single parameter with description; description does not add extra semantic information beyond what schema provides, so baseline 3 applies.

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 it indexes/re-indexes context artifacts from .socraticodecontextartifacts.json, specifying chunking and embedding for vector DB. It distinguishes from sibling codebase_context_search by mentioning auto-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?

Explicitly says 'Usually not needed — codebase_context_search auto-indexes on first use', providing when-to-use and an alternative tool, which is excellent guidance.

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