OKF: Generate index.md

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is known; the description usefully specifies exactly what is destroyed ('replacing the old listing') and what is preserved ('keeping its frontmatter'), plus the non-obvious recursive behavior that subfolders lacking an index.md also get one. It stops short of saying what happens on a nonexistent folder or whether existing subfolder indexes are rewritten.

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?

Two short sentences with zero filler; the primary action and its outputs come first, and the recursive subfolder caveat is placed as a trailing note where it belongs.

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 one-parameter tool with an output schema, the description covers the essential behavioral facts: content generated, overwrite semantics, frontmatter preservation, and recursive scope. Minor gaps remain around error behavior for missing folders and whether subfolder indexes are regenerated or only created.

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?

With one parameter at 100% schema coverage, the schema already documents the folder string and the root default, so the baseline of 3 applies. The description only reinforces that the target is 'a folder's' index and adds no syntax, path-resolution, or edge-case detail beyond the schema.

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 ('Write a folder's Open Knowledge Format index.md') and immediately enumerates the content produced: a link per note with its description plus a link per subfolder index. This is clearly distinguishable from siblings like okf_validate, okf_convert_links, reindex, and get_index_status.

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?

Usage is implied rather than stated: the reader infers you run this after notes change to regenerate a folder listing. There is no explicit when-to-use or when-not-to-use guidance, and no routing versus reindex or get_index_status, which an agent may plausibly confuse with index maintenance.

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