index_rules_from_markdown

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

With no annotations, the description carries the burden and largely meets it: it declares 'Access level: write', discloses that atomic mode updates existing rules in place (a destructive-ish upsert by code), that legacy mode never writes to rules, and lists the returned counts plus parser warnings/errors. Not covered are permissions/auth beyond the 'write' label and what happens on parse failure for the whole file.

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?

Front-loads the purpose in one sentence, then the two modes, then access level and return shape as scannable labeled lines. There is some duplication of the schema's mode text, which is the only real waste.

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?

An output schema exists, so return details are not strictly required, yet the description still summarizes counts, per-scope breakdown, warnings and errors, giving an agent a full picture of a three-parameter write tool. Only file-path preconditions and failure behavior are unaddressed.

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% and the schema's own mode description already explains both values in detail, so the description's mode paragraph largely echoes structured data. It adds no new syntax for filepath or default_scope_id, so the baseline 3 is appropriate.

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?

States a specific verb and resource ('Index rules from a markdown file') plus the destination ('directly into SQLite'), which is more informative than a bare name restatement. It does not explicitly distinguish itself from the sibling index_lessons_from_markdown, but the rules/lessons split is self-evident from the resource named.

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 gives clear conditional guidance for the main decision point: mode='atomic' upserts canonical blocks by code while mode='legacy' stages pending_proposals instead of writing to rules. It stops short of naming alternatives such as convert_to_atomic_format or extract_rules_from_transcript, but the mode-selection context is concrete.

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