suggest_metadata

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

Describes read-only nature, never edits YAML. Mentions environment-specific availability (PRIZMA/SLOI modes) for semantic fields. Explains optional context object for testing overrides without changes.

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 with no redundancy. Each sentence adds critical information.

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?

Covers purpose, usage, behavior, and parameters. Lacks error handling or performance notes, but given no annotations and 2 parameters, it is sufficiently complete.

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 covers both parameters with descriptions. Description adds context that context object allows testing overrides without editing. Also lists return fields (domain sign, material type, etc.).

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?

Clearly states it analyzes a note and proposes metadata for review, listing specific outputs. Distinguishes from siblings like read_file and write_file by explicitly referencing classification help and auditing.

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 to use before write_file for classification help or to audit an existing note. Notes it is read-only. Does not elaborate on alternatives like embed or get_parents, but guidance is clear.

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