Skip to main content
Glama

health

Analyze your project's health based on configuration, code quality, structure, documentation, and testing readiness. Obtain a grade (A-F) with detailed recommendations.

Instructions

Get a comprehensive health score for your project. Analyzes configuration, code quality, structure, documentation, and testing readiness. Returns a grade (A-F) with detailed recommendations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
detailedNoInclude detailed breakdown by category (default: true)
projectPathNoProject path to analyze (default: current project)
Behavior3/5

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

With no annotations, the description must cover behavioral traits. It mentions analysis scope and output (grade A-F, recommendations) but does not state if the tool is read-only, whether it requires specific permissions, or any side effects. This is adequate but lacks depth.

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 three concise sentences with no wasted words. It efficiently conveys the purpose, scope, and output format.

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 no output schema, the description adequately hints at the return value (grade and recommendations). However, it could be more precise about the response structure. With two optional parameters and no required ones, it is mostly complete.

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 coverage is 100%, so the baseline is 3. The description adds no additional context about the parameters beyond what the schema provides. It could mention that 'detailed' controls the level of granularity, but it doesn't.

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 clearly states the tool provides a comprehensive health score for a project, analyzing specific areas (configuration, code quality, etc.) and returning a grade with recommendations. This distinguishes it from sibling tools like 'analyze' or 'review'.

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 usage for project health assessment but does not explicitly state when to use this tool versus alternatives like 'analyze' or 'review'. No exclusion criteria or context is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/isucorp-taimiralain/StackGuide-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server