Speakeasy Logo
Skip to Content
DocumentationStandalone McpGenerate MCP Server from OpenAPI/Swagger

Generate MCP Server from OpenAPI/Swagger

Learn how to build MCP servers from your API specifications using Speakeasy for production-ready servers with extensive customization options.

Getting started with Speakeasy

To build an MCP server using Speakeasy:

  1. Install the Speakeasy CLI:

  2. Run Speakeasy quickstart:

  3. Indicate whether you plan to deploy your server on Cloudflare: Cloudflare  is a popular choice for hosting MCP servers. If selected, a Cloudflare Worker config file will be generated with your MCP server code. This will make deploying your server to Cloudflare Worker easy.

This creates a TypeScript-based MCP server in the specified directory ready to be deployed into production.

Example server code

The generated MCP server includes a comprehensive file structure with TypeScript source code:

    • core.ts
      • build.mts
      • cli.ts
      • console-logger.ts
      • extensions.ts
      • mcp-server.ts
      • prompts.ts
      • resources.ts
      • scopes.ts
      • server.ts
      • shared.ts
      • tools.ts

Run your MCP server locally

Local Development Setup

For local development and debugging, you can run your MCP server directly from the generated code:

This configuration allows you to:

  • Debug your server code directly
  • Make real-time changes during development
  • Test API integrations locally
  • Validate tool functionality before distribution

Testing with Published Package

Once you’ve published your MCP server to npm (following our SDK Publishing Guide), you can test using the npm package format that will be used in production:

Note: You must first publish your package to npm before you can test it using this configuration.

Using the Generated DXT

For the most user-friendly testing experience, use the generated DXT package. Claude Desktop and other MCP clients can load DXT files directly:

  1. Locate your generated DXT file in the output directory (typically with a .dxt extension)
  2. Install the DXT in your MCP client following the client’s installation process
  3. Configure environment variables if your server requires authentication

Advanced configuration

Specify scopes at runtime

When starting the MCP server, you can specify which scopes to include:

This example configuration only mounts tools tagged with the read scope, creating a read-only server.

Specify individual tools

You can further limit the subset of tools mounted on an MCP server by specifying individual tool names:

Distribution and hosting options

Speakeasy generates MCP servers with three primary distribution methods. These methods are not mutually exclusive - most customers use all three approaches to serve different use cases, with npm being the most common starting point:

1. Distribute on npm

Publishing your MCP server as an npm package provides the most flexible distribution method. Follow the SDK publishing guide for detailed instructions on publishing to npm and other package managers.

Benefits:

  • Universal compatibility: Single command works with all major MCP clients
  • Easy customization: Users can modify tools, add tools, and extend functionality
  • Version management: Standard npm versioning and dependency management
  • Team sharing: Simple distribution across development teams

Usage:

2. Host on Cloudflare Workers

Cloudflare hosting enables OAuth authentication flows and eliminates the need for users to manage API keys directly:

Benefits:

  • OAuth support: End-users authenticate through OAuth instead of providing API keys
  • Serverless hosting: No infrastructure management required
  • Global distribution: Cloudflare’s edge network for low latency
  • Same customization: Full tool customization capabilities available

Setup: Follow the Cloudflare deployment guide for detailed instructions.

3. Distribute as Desktop Extension (DXT)

DXT provides a drag-and-drop experience for end users, particularly in Claude Desktop:

Benefits:

  • User-friendly installation: Drag-and-drop installation in Claude Desktop
  • Guided setup: Nicely prompts end-users for API keys and auth credentials
  • Self-contained: All dependencies and metadata bundled together
  • Cross-platform: Works across different operating systems and MCP clients

DXT Generation: Speakeasy automatically generates Anthropic Desktop Extensions (.dxt)  as part of MCP server generation. The DXT includes:

  • A manifest.json file with metadata describing your MCP server
  • All necessary server files packaged for distribution
  • Tool descriptions and parameters automatically inferred from your OpenAPI specification
  • Icon and branding assets (if provided)

DXT Customization: You can customize the generated DXT manifest through the gen.yaml configuration file:

Hybrid Distribution Strategy

You can use all three distribution methods simultaneously, giving users flexibility to choose their preferred installation method based on their specific needs and technical requirements.

Best practices

When building MCP servers with Speakeasy:

  1. Use clear OpenAPI documentation - Well-documented APIs generate better MCP tools
  2. Leverage the x-speakeasy-mcp extension - Customize tool names, descriptions, and scopes
  3. Implement proper error handling - Ensure your API returns meaningful error messages
  4. Test thoroughly - Verify your MCP server works with different clients
  5. Version your APIs - Use semantic versioning for your OpenAPI specifications
  6. Monitor performance - Track usage and performance of your MCP tools
  7. Provide clear branding - Include a .png icon file in your project for automatic DXT  icon detection
  8. Customize DXT metadata - Use dxtManifestOverlay in gen.yaml to provide custom display names and descriptions

Next steps

Having set up your MCP server with Speakeasy, explore these additional capabilities:

Last updated on