Skip to main content
Glama

rest_validate_conventions

Check REST API design against best practices and naming conventions. Submit an OpenAPI spec and select strictness level to catch violations and enforce consistent standards.

Instructions

Pro: Validate REST API design against best practices and naming conventions

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNoAPI key for authentication
strictnessNoValidation strictness levelstandard
openapi_specYesOpenAPI/Swagger spec or list of endpoints to validate
Behavior2/5

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

No annotations are present, so the description carries the full burden of behavioral disclosure. It only says the tool validates, without revealing whether it is purely read-only, whether it calls an external service, whether an api_key is required for that reason, or what kind of report/result is produced. This is a significant gap for a tool with no output schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, compact sentence with no real fluff. The 'Pro:' prefix is mildly confusing and adds little value, but the core message is front-loaded and easy to parse.

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

Completeness2/5

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

The schema covers parameter inputs, but there is no output schema and no annotation context. The description does not explain what the validation result looks like, how strictness affects behavior, what 'list of endpoints' means, or whether the tool mutates anything. For an agent to confidently invoke this tool, too much is left unspecified.

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 the schema already defines api_key, strictness, and openapi_spec. The description adds no parameter-level detail beyond the schema, so the baseline score of 3 is appropriate.

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?

The description states a specific action and resource: it validates REST API design against best practices and naming conventions. It is not tautological. However, it does not explicitly distinguish itself from sibling tools like docs_validate_spec or rest_design_endpoints, so an agent must infer the boundary.

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

Usage Guidelines2/5

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

The description gives no guidance on when to use this tool versus alternatives such as docs_validate_spec, rest_design_endpoints, or openapi_generate_client. Usage is only vaguely implied by the word 'Validate'; there are no exclusions, prerequisites, or alternative routing cues.

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/barnburner121/claude-plugin-marketplace'

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