Skip to main content
Glama

Project Readiness Report

project_readiness_report

Generates a formatted Markdown project readiness report that identifies missing files, scores audit readiness, and recommends next actions.

Instructions

Generate a formatted Markdown project readiness report showing missing files, scoring audit, and recommended actions.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "project_readiness_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden and it does not say whether this is read-only analysis or whether it writes a report file to disk. "Generate" is ambiguous about side effects, and there is no statement about what gets inspected or any required project state.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One front-loaded sentence with no filler and a useful enumeration of report sections. It is tight, though its brevity is partly the cause of the missing differentiation and parameter detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return formatting need not be re-explained. But for a report-generation tool sitting next to assess_project_readiness, the description leaves out the path semantics and whether artifacts are written, which are the gaps that matter for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single path parameter has 0% schema description coverage and a default of ".", and the description never mentions it. It does not clarify that path is the project root to scan, which is the one piece of meaning an agent needs here.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and artifact ("Generate a formatted Markdown project readiness report") and enumerates the report's contents (missing files, scoring audit, recommended actions). It does not, however, distinguish this from the close sibling assess_project_readiness, so an agent must guess which of the two produces the report.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance and no mention of the obvious alternative, assess_project_readiness. Nothing states prerequisites (e.g., whether a project brain/context must exist first) or when a Markdown report is preferable to the assessment tool.

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