MCP Openai Server

🚀 OpenAI MCP 服务器

OpenAI MCP 服务器是一个基于模型上下文协议 (MCP) 的实现，为 OpenAI API 服务。它为 Augment 等应用程序与 OpenAI 的大语言模型 (LLM) 搭建了标准化接口，借助官方的 MCP SDK 实现稳定交互。

🚀 快速开始

本服务器使用官方 MCP SDK 构建，为应用程序与 OpenAI 的大语言模型交互提供了标准化接口。以下是快速启动服务器的步骤：

先决条件

• Node.js (v16 或更高版本)
• npm 或 yarn
• OpenAI API 密钥

安装步骤

1. 克隆此仓库或复制文件到项目目录。
2. 安装依赖项：

npm install

3. 基于提供的 .env.example 创建一个 .env 文件：

cp .env.example .env

4. 将 OpenAI API 密钥添加到 .env 文件中：

OPENAI_API_KEY=your_openai_api_key_here

运行服务器

使用以下命令启动服务器：

npm start

若要在开发过程中实现文件更改自动重启，可使用：

npm run dev

✨ 主要特性

• 🔄 使用官方 MCP SDK 以确保兼容性。
• 安全的 API 密钥管理。
• 📊 支持对话完成。
• 📋 模型列表。
• 🧠 文本嵌入生成。
• ⚠️ 正确的错误处理和日志记录。

📦 安装指南

环境准备

确保你的环境中已经安装了 Node.js（v16 或更高版本）和 npm 或 yarn，并且拥有有效的 OpenAI API 密钥。

安装依赖

npm install

配置环境变量

基于 .env.example 创建 .env 文件，并将 OpenAI API 密钥添加到其中：

cp .env.example .env

OPENAI_API_KEY=your_openai_api_key_here

💻 使用示例

基础用法

与 Augment 结合使用

要将此 MCP 服务器与 Augment 配合使用，将以下内容添加到 Augment 的 settings.json 文件中：

"augment.advanced": {
    "mcpServers": [
        {
            "name": "openai-mcp",
            "command": "node",
            "args": ["/path/to/openai-mcp-server.js"],
            "env": {
                "OPENAI_API_KEY": "your_openai_api_key_here",
                "DEBUG": "true"
            }
        }
    ]
}

请将 /path/to/openai-mcp-server.js 替换为实际的服务器文件路径。

高级用法

列出模型

列出所有可用的 OpenAI 模型。

对话完成

使用 OpenAI 的对话完成 API 生成回复。支持参数包括：

• model: 要使用的模型 (例如 gpt-3.5-turbo, gpt-4)
• messages: 对话消息数组
• temperature: 控制随机性 (0 - 1 之间)
• max_tokens: 要生成的最大标记数

创建嵌入

使用 OpenAI 的嵌入 API 为文本生成嵌入。支持参数包括：

• model: 要使用的模型 (例如 text-embedding-ada-002)
• input: 要嵌入的文本（字符串或字符串数组）

📚 详细文档

测试

在 client-example.js 中提供了一个测试此 MCP 服务器的示例客户端。运行：

node client-example.js

理解代码

该服务器包含几个关键组件：

1. MCP SDK 集成：使用官方 MCP SDK 以实现标准化通信。
2. 工具处理程序：实现每个支持工具的处理程序。
3. OpenAI API 集成：与 OpenAI 的 API 通信。
4. 错误处理：提供一致的错误响应。
5. 日志记录：记录操作以进行调试。

潜在改进

参见 mcp-server-improvement-suggestions.md 了解可以对此实现进行改进的一系列潜在建议。

🔧 技术细节

本服务器通过官方 MCP SDK 实现标准化通信，将应用程序请求转换为 OpenAI API 所需的特定格式。在处理不同工具时，会根据用户传入的参数调用相应的 OpenAI API 接口。同时，服务器具备完善的错误处理和日志记录机制，以确保系统的稳定性和可维护性。

📄 许可证

本项目采用 MIT 许可证。