assess_project_readiness

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

No annotations are provided, so the description carries the full burden. 'Scan the workspace' and 'evaluate' clearly imply a read-only, non-destructive analysis. However, it does not disclose whether any state is modified, what happens if required documents are missing, or whether any prerequisites must be met. This is adequate but lacks explicit safety confirmation.

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 concise sentence that front-loads the main action ('Scan the workspace') and immediately states the evaluation criteria. It contains no filler, repetition, or unnecessary detail, making it easy to parse quickly.

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 tool with one optional parameter and an output schema, the description sufficiently conveys the tool's purpose and expected outcome. It could add context about prerequisites or behavior when documents are missing, but the output schema likely covers return value details, so this is a minor gap rather than a critical omission.

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 schema has one optional 'path' parameter with 0% description coverage, and the tool description does not mention the parameter at all. Since schema coverage is low, the description should compensate by explaining how to specify the workspace path, but it only vaguely refers to 'the workspace' without connecting it to the parameter.

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 uses specific verbs 'scan' and 'evaluate' with a clear object ('workspace') and a specific outcome ('onboarding readiness score (0-100%) against required Project Brain documents'). It clearly distinguishes its focus from sibling tools like generate_project_brain (which creates documents) and project_readiness_report (which likely generates a report), by emphasizing a scored assessment.

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 usage for assessing onboarding readiness but does not explicitly state when to use this tool versus alternatives such as project_readiness_report or bootstrap_project. No exclusions or when-not-to-use guidance is provided, leaving it to the agent to infer appropriate timing.

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