m3_index

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

Since no annotations are provided, the description carries full burden. It states 'Read-only catalog metadata; never returns tool output,' clearly indicating safety and behavior. No side effects or prerequisites are noted, but adequate for a simple listing tool.

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 concise and front-loaded with key info: purpose, usage, output format, safety, and domain list. Every sentence adds value, though slight restructuring could improve readability.

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 no output schema, the description adequately explains the output structure. However, it fails to explain the 'database' parameter and does not differentiate from other listing siblings beyond the catalog focus. Missing some context.

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 0%. The description explains the 'domain' parameter by listing valid domains, but the 'database' parameter is not addressed at all. This leaves ambiguity for an agent, failing to fully compensate for the schema gap.

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 lists m3 catalog tools with optional domain filtering, returning structured rows with specific fields. It distinguishes itself from siblings like m3_call and other list tools.

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 recommends using this tool to discover exact args before calling m3_call, stating it's cheaper than a failed call. Implicitly contrasts with sibling tools but lacks explicit exclusions.

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