APIMatic OpenAPI Validator MCP Server

Overview

The APIMatic OpenAPI Validator is a powerful tool that helps you validate your OpenAPI specifications using APIMatic's comprehensive validation API. This integration allows you to check your API specifications directly within Claude, making it easier to identify and fix issues in your documentation.

Prerequisites

Before using this MCP server, you'll need:

1. Node.js v18 or higher installed on your system
2. An APIMatic API key (sign up at APIMatic to obtain one)

Installation

Step 1: Clone the Repository

First, clone the repository to your local machine:

git clone https://github.com/apimatic/apimatic-validator-mcp.git
cd apimatic-validator-mcp

Step 2: Install Dependencies

Install the required dependencies:

npm install

Step 3: Build the Project

Build the TypeScript project:

npm run build

Step 4: Configure Claude Desktop

To integrate the validator with Claude Desktop, you need to modify your Claude configuration file. The location depends on your operating system:

Windows:

%AppData%\Claude\claude_desktop_config.json

macOS/Linux:

~/Library/Application Support/Claude/claude_desktop_config.json

Add the following configuration to your claude_desktop_config.json file:

{
    "mcpServers": {
        "APIMatic": {
            "command": "node",
            "args": [
                "/path/to/apimatic-validator-mcp/build/index.js"
            ],
            "env": {
                "APIMATIC_API_KEY": "YOUR_APIMATIC_API_KEY"
            }
        }
    }
}

Replace /path/to/apimatic-validator-mcp with the actual path to the cloned repository on your system, and YOUR_APIMATIC_API_KEY with your APIMatic API key.

Usage

Once configured, you can use the validator in Claude Desktop:

1. Click the hammer icon in Claude Desktop to verify that the validate-openapi-using-apimatic tool is available
2. Upload or paste your OpenAPI specification (in JSON or YAML format)
3. Ask Claude to validate your OpenAPI specification
4. The validator will process your specification and return detailed validation results

Example Prompts

Here are some example prompts you can use with the validator:

• "Validate this OpenAPI specification using APIMatic"
• "Check if this API definition has any errors"
• "Analyze this OpenAPI file and tell me what needs to be fixed"

Troubleshooting

If you encounter issues with the validator:

1. Ensure your APIMatic API key is valid and correctly configured
2. Check that the path to the build directory is correct in your configuration
3. Verify that Node.js v18+ is installed and accessible
4. Restart Claude Desktop after making configuration changes

Additional Resources

• APIMatic Documentation
• OpenAPI Specification
• GitHub Repository