MCP OpenAPI Tools - VS Code Extension

Provides rich editing support for MCP OpenAPI Server configuration files (mcp-config.json).

Features

VSC-001: Syntax Highlighting

• Custom TextMate grammar for mcp-config.json files
• Highlights config section keys (server, openapi, authentication, etc.)
• Highlights environment variable references (${ENV_VAR})
• Highlights auth types, mock strategies, HTTP methods, URLs

VSC-002: JSON Schema Validation

• Automatic validation of mcp-config.json against the official schema
• Real-time error checking with descriptive messages

VSC-003: Snippets

• mcp-config — Basic configuration
• mcp-config-apikey — Config with API key auth
• mcp-config-bearer — Config with bearer token auth
• mcp-config-full — Full config with all sections
• mcp-config-mock — Config with mock mode
• mcp-security — Security section snippet

VSC-004: CodeLens Actions

• Register for Copilot — Writes .vscode/mcp.json for GitHub Copilot integration
• Start Server — Launches the MCP server in an integrated terminal
• Validate Config — Validates the configuration at the top of the file
• List Tools — Shows all tools from the OpenAPI spec
• Test Connection — Tests API connectivity
• Auth Info — Shows authentication type
• Mock Mode Toggle — Enable/disable mock mode with a click
• Server Info — Shows server name and version
• Hot Reload Status — Shows hot reload on/off with debounce setting
• Execution Settings — Shows timeout and retry info
• Filtering Info — Shows include/exclude tag counts
• Observability Status — Shows enabled observability features
• Security Status — Shows enabled security features

VSC-005: Tool Explorer (Sidebar)

• Tree view in the Explorer sidebar showing all MCP tools
• Tools grouped by OpenAPI tags
• Click to see tool details: parameters, request body, responses
• HTTP method icons (GET ↓, POST +, PUT ✎, DELETE 🗑, PATCH ✏)
• Config status at the top

VSC-006: Inline Documentation (Hover)

• Hover over config section keys for documentation
• Hover over property keys for descriptions
• Hover over ${ENV_VAR} to check if the variable is set
• Hover over auth types for setup examples
• Hover over mock strategies for explanations
• Hover over URLs for clickable links

Requirements

• VS Code 1.85.0 or later
• An mcp-config.json file in your workspace
• mcp-openapi-server npm package (for server commands)

npm install mcp-openapi-server

Server Binary Detection

The extension auto-detects the MCP server binary in this order:

1. User setting — mcpOpenapi.serverBinaryPath (if configured)
2. Local npm install — node_modules/.bin/mcp-openapi in workspace root
3. Dev fallback — dist/cli/index.js (for development in the project itself)
4. npx — npx mcp-openapi (uses the published npm package)

Extension Settings

Commands

Development

# Install dependencies
npm install

# Compile
npm run compile

# Run tests
npm test

# Watch mode
npm run watch

# Package as VSIX
npm run package