goodmemory_search_index

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

No annotations provided, so description must disclose behavior. It says output is a compact recordRef index (not full details), implies read-only, but doesn't specify permissions, idempotency, or side effects. Adequate but not thorough.

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 purpose. No wasted words, clear structure.

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?

Missing explanation of optional parameters (limit, retrievalProfile, includeRuntime) and output format. Does not fully describe how to chain steps or handle edge cases. Adequate for simple usage but incomplete given 6 parameters and no output schema.

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 33% (only 2 of 6 parameters have descriptions). Description adds no parameter-specific meaning beyond mentioning 'query' implicitly. Low compensation for poor schema coverage.

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 explicitly states it fetches a compact recordRef index for a query, part of progressive recall. Distinct from siblings: goodmemory_get_context (rendered summary) and goodmemory_get_records (detail).

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?

Clear usage context: prefer over goodmemory_get_context when specific records are needed, and it's step 1 followed by goodmemory_get_records. Explicit alternative and workflow.

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