vladnicula/vlads-openai-mcp-server
If you are the rightful owner of vlads-openai-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
A Model Context Protocol (MCP) server that facilitates interaction between Claude Code and OpenAI's GPT-5 and GPT-5-mini models.
OpenAI Multi-Model MCP Server
A Model Context Protocol (MCP) server that enables Claude Code to interact with OpenAI's GPT-5 and GPT-5-mini models.
Features
- Multi-model support: Choose between GPT-5 and GPT-5-mini per request
- Advanced parameters: Support for reasoning effort, verbosity control, and system instructions
- Type-safe: Built with TypeScript and Zod validation
- Error handling: Comprehensive error handling with structured responses
- MCP compliant: Full compatibility with MCP specification
Quick Start
Claude Code Configuration
Add to your Claude Code MCP configuration (typically in ~/.claude.json
):
Option 1 - From GitHub (Recommended):
{
"mcpServers": {
"openai-multi": {
"command": "npx",
"args": ["-y", "github:vladnicula/vlads-openai-mcp-server"],
"env": {
"OPENAI_API_KEY": "sk-your-openai-api-key-here"
}
}
}
}
Option 2 - Local installation:
{
"mcpServers": {
"openai-multi": {
"command": "node",
"args": ["/path/to/vlads-openai-mcp-server/build/index.js"],
"env": {
"OPENAI_API_KEY": "sk-your-openai-api-key-here"
}
}
}
}
Note: Adding this configuration to the root mcpServers
object will make it available in all instances of Claude Code.
Setup
If you wanna build this on your local machine, patch thing up, extend things. PRs are welcome btw.
Prerequisites
- Node.js 18+
- OpenAI API key
Installation
-
Clone or navigate to the project directory:
cd /path/to/vlads-openai-mcp-server
-
Install dependencies:
npm install
-
Create environment configuration (for local testing only):
cp .env.example .env # Edit .env and add your OpenAI API key - only needed for MCP Inspector testing
-
Build the project:
npm run build
Configuration
Environment Variables
Create a .env
file with:
OPENAI_API_KEY=sk-your-openai-api-key-here
Usage
Available Tools
openai_chat
Chat with OpenAI models including GPT-5 and GPT-5-mini.
Parameters:
model
(required): "gpt-5" or "gpt-5-mini"input
(required): String text input for the modelinstructions
(optional): System-level instructionsreasoning
(optional): Object witheffort
property ("minimal", "low", "medium", "high")text
(optional): Object withverbosity
property ("low", "medium", "high")max_tokens
(optional): Maximum tokens in response
Example:
// GPT-5 for complex tasks
await openai_chat({
model: "gpt-5",
input: "Explain quantum computing in detail",
instructions: "You are a helpful physics tutor",
reasoning: {
effort: "high"
},
text: {
verbosity: "high"
}
});
// GPT-5-mini for quick responses
await openai_chat({
model: "gpt-5-mini",
input: "What's the weather like?",
reasoning: {
effort: "minimal"
}
});
Development
Scripts
npm run dev
- Run in development mode with hot reloadnpm run build
- Build for productionnpm run start
- Run built versionnpm run inspector
- Test with MCP Inspectornpm run test
- Run tests
Testing
Use the MCP Inspector to test the server:
npm run inspector
This will start the MCP Inspector where you can:
- Test tool definitions
- Try different parameter combinations
- Verify error handling
Project Structure
src/
āāā index.ts # Main server entry point
āāā client.ts # OpenAI API client wrapper
āāā tools/
ā āāā index.ts # Tool registry
ā āāā chat.ts # Chat tool implementation
āāā schemas/
ā āāā index.ts # Zod validation schemas
āāā utils/
āāā env.ts # Environment validation
Model Comparison
Feature | GPT-5 | GPT-5-mini |
---|---|---|
Performance | Best | Fast |
Cost | Higher | Lower |
Context Window | 400k tokens | 400k tokens |
Verbosity Control | Yes | No |
Multi-modal | Yes | Yes |
Error Handling
The server provides structured error responses:
- Validation errors: Invalid input parameters
- API errors: OpenAI API issues (rate limits, auth, etc.)
- Network errors: Connectivity problems
- Unexpected errors: Any other failures
All errors include helpful messages and, where applicable, error codes.
Troubleshooting
Common Issues
-
Missing API Key
Missing required environment variable: OPENAI_API_KEY
Solution: Set your OpenAI API key in the environment
-
Model Not Found
OpenAI API Error: The model 'gpt-5' does not exist
Solution: Ensure you have access to GPT-5 models in your OpenAI account
-
Rate Limits
OpenAI API Error: Rate limit exceeded
Solution: Wait and retry, or upgrade your OpenAI plan
Debug Mode
The server logs detailed information to stderr:
- Request details
- Response metadata
- Error information
License
MIT
Contributing
- Follow the existing code style
- Add tests for new features
- Update documentation
- Ensure all tests pass