Skip to main content
Glama

Assess Project Readiness

assess_project_readiness

Scans the workspace to evaluate onboarding readiness against required Project Brain documents, returning a 0–100% score to identify missing documentation.

Instructions

Scan the workspace and evaluate its onboarding readiness score (0-100%) against required Project Brain documents.

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": "assess_project_readiness"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3/5.0
Behavior3/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. 'Scan' and 'evaluate' imply a read-only operation, and the 0-100% scoring behavior is disclosed, but there is no statement about side effects, required permissions, or what happens if Project Brain documents 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.

Conciseness4/5

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

A single front-loaded sentence that wastes no words and leads with the action and the output. It is dense but readable; the only cost is that brevity leaves gaps elsewhere.

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

Completeness3/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 values need not be explained. But for a tool sitting among many close siblings, the description lacks path semantics, prerequisites, and sibling differentiation, leaving it only minimally adequate.

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?

Schema description coverage is 0% for the single 'path' parameter, and the description never mentions it. It gives no indication that the tool accepts a path or that it defaults to the current directory, so an agent gains no meaning beyond the raw schema type.

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?

States a specific verb pair (scan, evaluate) and a concrete output (onboarding readiness score 0-100% against required Project Brain documents). It is clear what the tool does. However, it does not differentiate itself from the sibling 'project_readiness_report', which sounds nearly identical in intent.

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 explicit when-to-use guidance, no prerequisites (e.g., whether a Project Brain must already exist), and no mention of alternatives such as 'project_readiness_report' or 'doctor'. Usage is only inferable from the word 'onboarding'.

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