PAIDEIA__build_course_index

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

No annotations are provided, and the description does not disclose behavioral traits such as side effects (e.g., file creation or modification), permissions required, or whether it is safe or destructive. The description only states what the tool does, not how it behaves beyond the action.

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 concise with two sentences: one establishing the alias and usage, the other describing the action. It is front-loaded and avoids unnecessary words, though it could be slightly more structured.

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's simplicity and that the schema covers parameters, the description provides the core information about its purpose and output files. However, it lacks details about return values or error states, and since there is no output schema, the description does not fully compensate. It is adequate but not 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?

The input schema already describes all three parameters (force, weak_zones, project_root) with clear descriptions. The tool description adds no additional meaning or context about the parameters beyond what is in the schema, but since schema coverage is 100%, the baseline of 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?

The description clearly states the tool is a PAIDEIA namespace alias for build_course_index and describes the action: 'Inventory converted/markdown files and write a draft course-index/{summary,patterns,coverage}.md baseline.' It distinguishes itself from the sibling tool 'build_course_index' by its namespace prefix, making the purpose understandable.

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 advises using this exact name when an AI searches for it, but does not elaborate on when to choose this alias over the non-prefixed sibling or provide context on when not to use it. This gives minimal usage guidance.

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