Snaggle Ai Openapi MCP Server

🚀 OpenAPI MCP Server

Easily converse with any OpenAPI (v3.1) compliant API via Claude Desktop!

This tool creates a Model Context Protocol (MCP) server that acts as a proxy for any API with an OpenAPI v3.1 specification. This allows you to easily interact with APIs on local and remote servers using Claude Desktop.

If you encounter issues where Claude crashes or the specification is unusable, process it through our Specification Cleaner Application. This tool organizes some OpenAPI schemas to help them become LLM-readable.

✨ Features

This proxy automatically converts OpenAPI endpoints into Claude tools, enabling Claude to:

1. Discover available API endpoints and understand their purposes
2. Comprehend required parameters and their types
3. Make API calls on your behalf
4. Handle responses appropriately

For example, if you have a Petstore API with this endpoint:

/pets/{petId}:
  get:
    operationId: getPetById
    summary: Returns a pet by ID
    parameters:
      - name: petId
        in: path
        required: true
        schema:
          type: integer
          format: int64

Claude will be able to understand and execute this endpoint via natural language, returning detailed information about the pet.

📦 File Upload Support

In addition to handling standard API requests, the OpenAPI MCP server also supports file uploads. You can configure file uploads as follows:

1. Define FormData parameters in the OpenAPI specification:

parameters:
  - name: file
    in: formData
    required: true
    schema:
      type: string
      format: binary

2. Handle file uploads on the server side:

const uploadedFile = await request.file('file');
// Process the uploaded file

🚀 Quick Start

1. Configure Claude Desktop: Add the following to your claude_desktop_config.json file:

   {
     "mcpServers": {
       "petstore-api": {
         "command": "npx",
         "args": ["openapi-mcp-server", "/absolute/path/to/petstore-openapi.json"]
       }
     }
   }
   

2. Restart Claude Desktop and start interacting with your API!

💻 Usage Examples

Basic Usage

This repository contains a complete Petstore API server example that you can use to test the OpenAPI MCP server. The example server implements a basic CRUD API to manage pets, making it an ideal choice for learning to use this tool.

For instructions on how to run the example server, refer to examples/README.md.

📚 Documentation

Use Cases

1. Local Development

   • Test your APIs through natural conversations
   • Debug endpoints before writing code
   • Interactively explore API functionality

2. API Integration

   • Quickly test third-party APIs
   • Prototype before writing code
   • Understand new APIs through conversations

3. Documentation

   • Ask questions about API endpoints
   • Get examples of using endpoints
   • Comprehend error conditions

Limitations

• Currently only supports the OpenAPI v3.1 specification
• Response handling is optimized for JSON/text
• File uploads only support local files (remote URLs are not supported)
• Streaming responses are not yet implemented

Development

Pending tasks are listed in TODO.md.

Basic operations:

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build the project
pnpm build

# Link the project to the global node_modules for npx usage
npm link

# Now start Claude Desktop to begin using

# Rebuild after making changes to update Claude Desktop
pnpm build

# Now restart Claude Desktop to use the latest changes

📄 License

MIT

Built with ❤️ to make APIs more accessible via natural language.