search_by_frontmatter

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

No annotations are provided, so the description carries full burden. It discloses partial match and case-insensitivity for the value parameter but does not specify return format (e.g., note paths or content) or behavior when property is missing.

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 two sentences with zero wasted words, front-loaded with the verb and resource, and includes a clarifying example. Every sentence earns its place.

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?

For a simple 2-param tool with no output schema, the description is nearly complete. It lacks explicit mention of return format (e.g., file paths, note IDs) but the context of sibling tools (read_note, search_notes) helps infer it. Minor gap.

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 100%, so the baseline is 3. The description adds an example but no new meaning beyond what the schema already provides ('Value to match (partial match, case-insensitive)' and 'Frontmatter key to search').

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 specifies the verb 'Finds', resource 'notes', and condition 'YAML frontmatter property matches a value'. It includes an example that distinguishes it from siblings like 'search_notes' (full-text) and 'get_notes_by_tag'.

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?

The description implies use for frontmatter-based searches but does not explicitly state when to use this tool versus alternatives (e.g., search_notes for full-text, get_notes_by_tag for tags). No exclusions or when-not guidance is provided.

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