Skip to main content
Glama

score_project

Scores projects on AI-readiness (0-100%) by evaluating documentation, infrastructure, code quality, and security, returning a letter grade with a detailed breakdown.

Instructions

Score one or all projects on AI-readiness (0-100%). Checks documentation (copilot-instructions, README, CLAUDE.md, .cursorrules, SKILLS.md, .env.example), infrastructure (git, hooks, Docker, CI, deploy scripts, PM2), code quality (tests, TypeScript, linting, npm scripts), and security (.env gitignored, secrets exposure, lockfiles). Returns letter grade (A+ to F) with detailed breakdown.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectNoProject name OR absolute directory path to score. Omit to score all projects.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.9.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations at all, the description carries the behavioral transparency burden, and it does a solid job by listing exactly what is inspected and what is returned. It explicitly states the return value: 'letter grade (A+ to F) with detailed breakdown'. It does not explicitly say whether the operation is read-only or whether it can modify anything, but the analysis-oriented language ('checks', 'scores', 'returns') makes the behavior reasonably clear.

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

Conciseness5/5

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

The description is front-loaded with the core action and then delivers every detail in compact, scannable lists. Each sentence earns its place: the scoring target, the checked categories, and the output format. No filler or repetition.

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

Completeness4/5

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

Given the tool's moderate complexity, no annotations, and no output schema, the description is nearly complete: it explains the input, the criteria being evaluated, and the output grade with breakdown. Minor gaps are the lack of an explicit read-only/no-side-effects statement and no mention of error conditions or prerequisites, but an agent can confidently invoke the tool with the information provided.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents the single optional 'project' parameter as a name or absolute path and notes that omitting it scores all projects. The main description repeats the 'one or all' idea but adds no parameter semantics beyond what the schema provides. Baseline 3 is appropriate.

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

Purpose5/5

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

The description opens with a specific verb and resource: 'Score one or all projects on AI-readiness (0-100%)'. It then enumerates the exact dimensions checked (documentation, infrastructure, code quality, security), which makes the tool's identity unambiguous. Even without naming siblings like run_audit or audit_verify, the detailed rubric clearly distinguishes this tool.

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

Usage Guidelines3/5

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

The description implies when to use the tool: whenever an AI-readiness score for one or all projects is needed. It also communicates the key invocation choice via 'Omit to score all projects'. However, it never explicitly contrasts this with sibling tools or states when NOT to use it, so the usage guidance is implied rather than explicit.

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