OpenAI MCP Getting Started Example
2025.04.21
3
TypeScriptOpenAI集成MCP协议示例开发效率
该项目展示了如何通过MCP协议与OpenAI进行交互。它提供了一个简单的示例，通过MCP服务器、主机和客户端无缝地与OpenAI的API进行交互。
View on GitHub
Overview
基本能力
产品定位
该项目是一个示例项目，展示了如何通过MCP协议与OpenAI进行交互，适用于开发者和研究人员快速上手MCP协议与OpenAI的集成。
核心功能
- 支持SSE（Server-Sent Events）
- 支持工具调用（Tools）
- 支持多种认证方式（Azure OpenAI、OpenAI、GitHub Models）
适用场景
- 开发者快速测试和集成OpenAI API
- 研究人员通过MCP协议与OpenAI进行交互
- 使用Azure OpenAI、OpenAI或GitHub Models进行模型调用
工具列表
calculate_sum: 计算两个数字的和calculate_product: 计算两个数字的乘积calculate_difference: 计算两个数字的差calculate_division: 计算两个数字的商
常见问题解答
- 如何配置不同的认证方式？
- 通过
.env文件配置AZURE_OPENAI_ENDPOINT、OPENAI_API_KEY或GITHUB_TOKEN。 - 如何启用调试模式？
- 使用
DEBUG=true npm run host命令启用详细日志。
使用教程
使用依赖
- Node.js和npm（版本22或更高）
- OpenAI兼容的端点（OpenAI API密钥、GitHub令牌或Azure OpenAI资源）
安装教程
- 克隆仓库：
bash git clone https://github.com/manekinekko/openai-mcp-example.git cd openai-mcp-example - 安装依赖：
bash npm install
配置
Azure OpenAI
在.env文件中配置：
AZURE_OPENAI_ENDPOINT="https://<ai-foundry-openai-project>.openai.azure.com"
MODEL="gpt-4.1"
登录Azure CLI：
az login
OpenAI
在.env文件中配置：
OPENAI_API_KEY=your_openai_api_key
MODEL="gpt-4.1"
GitHub Models
在.env文件中配置：
GITHUB_TOKEN=your_github_token
GITHUB_MODEL="openai/gpt-4.1"
使用
- 运行MCP服务器：
bash npm run server - 运行MCP主机：
bash npm run host
调试方式
- 启用详细日志：
bash DEBUG=true npm run host - 检查MCP服务器：
bash npm run inspect