Skip to main content
Glama

validate_docs

Check project documentation against team policy standards. Verifies required files exist, template placeholders are filled, sections are present, and minimum items are met. Returns pass/warn/fail status with detailed findings.

Instructions

Validate project docs against team policy (policy.toml). Checks: required files exist, template placeholders filled, required sections present, minimum list items. Returns pass/warn/fail status per file with details.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations provided, so description carries full burden. Discloses return format (pass/warn/fail status per file) and validation logic, but omits safety profile (read-only vs. destructive), side effects (does it write logs?), and error handling (what if policy.toml is missing?). 'Validate' implies read-only but should be explicit.

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?

Two sentences, zero waste. First sentence establishes purpose and policy reference. Second sentence lists specific checks and return format. Front-loaded with actionable verb and efficiently structured.

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?

Good coverage given zero parameters and no output schema. Describes validation criteria and return structure adequately. Minor gap: doesn't specify project selection mechanism (likely context-dependent) or behavior when policy.toml is absent.

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

Parameters4/5

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

Zero parameters per schema. Baseline 4 applied per rubric (0 params = baseline 4). Description correctly omits parameter discussion as none exist; no compensation needed.

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?

Excellent specificity: states exact verb (validate), resource (project docs), scope (against policy.toml), and enumerates four distinct validation checks (files, placeholders, sections, list items). Clearly distinguishes from sibling `audit_project` by focusing on policy.toml compliance rather than general auditing.

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?

Provides implied usage through specific check enumeration, but lacks explicit when-to-use guidance or differentiation from siblings like `check_doc_changes` (which likely checks modifications) or `audit_project` (which likely checks broader compliance). No prerequisites or exclusions stated.

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/epicsagas/alcove'

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