Skip to main content
Glama

lint_project_docs

Validate project documentation against standards by checking required files, frontmatter, dependencies, missing fields, and formatting errors. Auto-fix common issues and optionally enforce stricter rules to ensure quality before commits.

Instructions

Validates project documentation against standards. Checks for required files, valid frontmatter, broken dependencies, missing fields, and formatting issues. Can auto-fix common problems. Run this before commits to ensure documentation quality.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fixNoIf true, automatically fix issues that can be auto-corrected (missing timestamps, formatting, etc.). Default: false (report only).
strictNoIf true, enforce stricter rules (all tasks must have estimates, due dates, descriptions). Default: false.
scopeNoWhat to lint: "all" (everything), "tasks" (only task files), "docs" (only documentation files). Default: "all".all
Behavior3/5

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

With no annotations, the description must fully disclose behavior. It states validation and auto-fix capability, implying mutation, but does not describe side effects, idempotency, or run safety. Partially transparent.

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?

Three sentences efficiently cover purpose, capabilities, and usage advice. No redundant text; each sentence serves a purpose.

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

Completeness5/5

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

For a tool with 3 optional parameters and no output schema, the description provides sufficient context: what it checks, when to use, and auto-fix option. Covers all necessary aspects.

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 parameters are well-documented in schema. The description adds high-level context but no additional semantics per parameter beyond the schema defaults and enums.

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 validates project documentation against standards, listing specific checks (required files, frontmatter, dependencies, etc.) and the ability to auto-fix. It is distinct from sibling tools, which are mostly CRUD operations and project management functions.

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

Usage Guidelines4/5

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

Explicitly advises to run before commits to ensure quality, providing clear context. However, it does not mention when not to use or alternatives, though no direct sibling linter exists.

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/pouyanafisi/project-mcp'

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