Skip to main content
Glama
CSOAI-ORG

API Docs Generator AI MCP

validate_spec

Analyze OpenAPI specifications to detect common validation issues and errors. Use it to ensure your API spec conforms to best practices.

Instructions

Validate an OpenAPI spec for common issues.

Behavior: This tool is read-only and stateless — it produces analysis output without modifying any external systems, databases, or files. Safe to call repeatedly with identical inputs (idempotent). Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.

When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.

When NOT to use: Not suitable for real-time production decision-making without human review of results.

Args: spec_json (str): The spec json to analyze or process. api_key (str): The api key to analyze or process.

Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent — calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spec_jsonYes
api_keyNo

Implementation Reference

  • The main handler function for the validate_spec tool. Registered via @mcp.tool() decorator (line 322). It validates an OpenAPI spec JSON string by: (1) checking access/rate limits, (2) parsing JSON, (3) validating presence of 'openapi', 'info.title', 'info.version', 'paths', (4) validating paths start with '/', (5) validating HTTP methods, (6) warning on missing responses. Returns {'valid': bool, 'errors': list, 'warnings': list}.
    @mcp.tool()
    def validate_spec(spec_json: str, api_key: str = "") -> dict:
        """Validate an OpenAPI spec for common issues.
    
        Behavior:
            This tool is read-only and stateless — it produces analysis output
            without modifying any external systems, databases, or files.
            Safe to call repeatedly with identical inputs (idempotent).
            Free tier: 10/day rate limit. Pro tier: unlimited.
            No authentication required for basic usage.
    
        When to use:
            Use this tool when you need structured analysis or classification
            of inputs against established frameworks or standards.
    
        When NOT to use:
            Not suitable for real-time production decision-making without
            human review of results.
    
        Args:
            spec_json (str): The spec json to analyze or process.
            api_key (str): The api key to analyze or process.
    
        Behavioral Transparency:
            - Side Effects: This tool is read-only and produces no side effects. It does not modify
              any external state, databases, or files. All output is computed in-memory and returned
              directly to the caller.
            - Authentication: No authentication required for basic usage. Pro/Enterprise tiers
              require a valid MEOK API key passed via the MEOK_API_KEY environment variable.
            - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are
              included in responses (X-RateLimit-Remaining, X-RateLimit-Reset).
            - Error Handling: Returns structured error objects with 'error' key on failure.
              Never raises unhandled exceptions. Invalid inputs return descriptive validation errors.
            - Idempotency: Fully idempotent — calling with the same inputs always produces the
              same output. Safe to retry on timeout or transient failure.
            - Data Privacy: No input data is stored, logged, or transmitted to external services.
              All processing happens locally within the MCP server process.
        """
        allowed, msg, tier = check_access(api_key)
        if not allowed:
            return {"error": msg, "upgrade_url": "https://meok.ai/pricing"}
    
        if not _check_rate():
            return {"error": "Rate limit exceeded (50/day)"}
        try:
            spec = json.loads(spec_json)
        except json.JSONDecodeError:
            return {"valid": False, "errors": ["Invalid JSON"]}
        errors = []
        warnings = []
        if "openapi" not in spec:
            errors.append("Missing 'openapi' version field")
        if "info" not in spec:
            errors.append("Missing 'info' object")
        else:
            if "title" not in spec["info"]:
                errors.append("Missing 'info.title'")
            if "version" not in spec["info"]:
                errors.append("Missing 'info.version'")
        if "paths" not in spec:
            errors.append("Missing 'paths' object")
        else:
            for path, methods in spec["paths"].items():
                if not path.startswith("/"):
                    errors.append(f"Path '{path}' must start with /")
                for method, definition in methods.items():
                    if method not in ("get", "post", "put", "patch", "delete", "head", "options", "trace"):
                        errors.append(f"Invalid method '{method}' on {path}")
                    if "responses" not in definition:
                        warnings.append(f"{method.upper()} {path} has no responses defined")
        return {"valid": len(errors) == 0, "errors": errors, "warnings": warnings}
  • server.py:322-322 (registration)
    The tool is registered with the MCP server using the @mcp.tool() decorator on the validate_spec function.
    @mcp.tool()
Behavior5/5

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

Thoroughly documents side effects (none), authentication (no auth for basic, pro key required), rate limits (10/day free), error handling (structured errors), idempotency, and data privacy. Since no annotations exist, the description fully compensates.

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

Conciseness3/5

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

Well-structured with sections, but verbose. The Behavioral Transparency block repeats info from the Behavior section. Could be more concise while retaining key details.

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?

Covers many aspects (behavior, auth, rate limits, error handling) despite no annotations or output schema. Missing: examples of common issues detected and the structure of the analysis output.

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

Parameters2/5

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

With 0% schema description coverage, the description provides only minimal parameter info (name, type, vague purpose). It does not explain format, constraints, or behavior differences between parameters, e.g., api_key usage for pro tier is only hinted in transparency, not in args.

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?

Description clearly states 'Validate an OpenAPI spec for common issues' with a specific verb and resource. It distinguishes from sibling tools like add_auth_to_spec, generate_endpoint, etc., which perform different operations.

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?

Includes explicit 'When to use' and 'When NOT to use' sections, giving context and an exclusion (not for real-time decisions without review). However, it does not name alternative sibling tools explicitly.

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/CSOAI-ORG/api-docs-generator-ai-mcp'

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