Index Code

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

With no annotations, the description carries the burden; it discloses the exact operation (chunk, embed, upsert), that it is unauthenticated and free, and warns that search is gated and requires external dependencies. It does not mention potential behavior like idempotency or overwriting existing chunks, but overall provides substantial transparency.

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 front-loaded with the core action and efficiently covers the important caveats. The extensive explanation of the external search endpoint and x402 dependency is relevant but somewhat lengthy; still, every sentence contributes to correct usage.

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 the tool's role in a broader pipeline, clarifies limitations (no search), and provides alternative invocation guidance. It omits the return value/response format, but for an indexing tool with no output schema, the provided context is largely sufficient.

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 both repoId and files described in the schema. The description does not add syntax or format details beyond the schema, though it does explain the end-to-end processing (chunked, embedded, upserted), leaving the schema as the primary documentation.

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 explicitly states the tool indexes repo files into a specific Worker and makes them semantically searchable, detailing chunking/embedding/upserting. It distinguishes itself from search by stating this tool only calls the free POST /index endpoint.

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?

It clearly explains when to use this tool (for indexing) and when not to (for searching), explicitly noting the search endpoint is not exposed and directing users to call POST /search directly with an x402-aware client. It also mentions it is free and unauthenticated.

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