Skip to main content
Glama

lint_agent_skill

Read-only

Lint an agent SKILL.md (markdown with YAML frontmatter) against the API Commons skill rules — name, description, structure, metadata.

Input Schema

NameRequiredDescriptionDefault
contextNoOptional: why you are asking. One sentence — the task you are trying to complete, or what you expect to get back. Never included in the answer and never used to rank; it is read only when a result turns out to be wrong, which is when knowing the intent is what makes the report actionable.
documentYesThe API description to operate on — OpenAPI, AsyncAPI, Arazzo or JSON Schema. A YAML/JSON string or an already-parsed object; both are accepted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered and the bar is lower. The description adds the scope of checks (name, description, structure, metadata), but says nothing about the report shape or whether findings are auto-fixed — relevant since fix_diagnostics is a sibling.

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?

One sentence, front-loaded with the verb and target, with the rule scope appended after the dash. Nothing is padded and nothing is redundant.

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

Completeness3/5

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

A two-parameter read-only tool with no output schema needs modest coverage, and the description identifies what is measured. It still omits whether results are pass/fail or diagnostic lists, and whether fixing is possible here, which matters for an agent deciding to act on the output.

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 coverage is 100%, so the baseline would be 3, but the description does real work: it clarifies that the input is a SKILL.md markdown document with YAML frontmatter, whereas the schema text generically says 'OpenAPI, AsyncAPI, Arazzo or JSON Schema'. That resolves a genuine ambiguity the schema leaves. The optional context parameter is still undescribed in the prose.

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

Purpose4/5

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

A specific verb (Lint) plus a specific resource (an agent SKILL.md with YAML frontmatter) and the rule set it checks against (API Commons skill rules: name, description, structure, metadata). It is clearly not validate_api or test_ruleset, though it never names the sibling it complements.

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?

Usage is only implied: you lint a SKILL.md before publishing or to check conformance. There is no explicit when-to-use statement, no prerequisites, and no routing to alternatives like validate_api, test_ruleset, or the nearby fix_diagnostics for acting on findings.

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