Build ReSpec Document

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

With no annotations, the description carries full burden. It mentions rendering, writing output, and returning compliance results, but lacks details on side effects (e.g., file overwriting), idempotency, permissions, or error behavior. Critical behavioral traits for a build tool are 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 a single sentence, concise and to the point. It front-loads the main action. Minor improvement could be breaking into two sentences for readability, but it is efficient.

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?

Given the tool has 5 parameters (none required), no output schema, and no parameter descriptions, the description is incomplete. It does not explain parameter roles, compliance result format, or prerequisites, leaving significant gaps for correct invocation.

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 0% and the description does not elaborate on any of the five parameters (profile, status, overrides, source, output). It mentions 'source file' and 'static HTML' but does not link them to parameters, providing no added value 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?

The description clearly states the tool renders a ReSpec source file to static HTML using a repo-local profile, writes output, and returns compliance results. It uses a specific verb ('renders') and resource ('ReSpec source file'), and distinguishes itself from sibling tools like respec_list_profiles (listing) and respec_validate (validation) by focusing on the build action.

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?

No guidance is provided on when to use this tool versus siblings. It does not mention prerequisites, when-not scenarios, or alternative tools. The description only states what the tool does, not the context for its use.

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