Skip to main content
Glama

Style-check spec content

style-check
Read-only

Get AI style feedback on requirements content against the project's style rubric. Pass 'markdown' to check content you're composing BEFORE creating/editing a document (recommended), or 'document' to check a document's published content. Provide exactly one of the two.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYesThe project target: its slug (find it with list-projects), e.g. 'acme-checkout'
documentNoA document target whose latest published content to check
markdownNoInline markdown content to check (pre-save compose loop)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds meaningful context beyond that: it is AI-generated feedback judged against a project rubric, and it is meant to run BEFORE creating/editing in a compose loop. It does not state rate limits or the shape of the feedback, but for a read-only check tool this is solid.

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 tightly packed sentences: the purpose leads, the mode guidance follows, and the exclusivity constraint closes. No filler; each sentence carries distinct information.

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?

No output schema exists, so the description needn't detail return values, and it conveys that the result is style feedback. Combined with 100% schema coverage and a clear readOnly annotation, the definition is nearly complete; only the precise form of the feedback is left implicit.

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?

Schema description coverage is 100%, so the baseline is 3. The description goes beyond the schema by clarifying the purpose of the two target parameters (compose-time markdown vs published document content) and by adding the mutual-exclusion rule 'provide exactly one of the two,' which the schema does not express.

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 gives a specific verb and resource: 'Get AI style feedback on requirements content against the project's style rubric.' An agent can immediately tell this tool produces style/rubric feedback rather than creating or editing documents, which differentiates it from near siblings like create-document and edit-document.

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

Usage Guidelines5/5

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

It explicitly states the two modes ('markdown' for content being composed, 'document' for published content), recommends the pre-save compose loop, and enforces the mutual-exclusion constraint ('Provide exactly one of the two'). The when-to-use for each branch is spelled out with no inference required.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources