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 許可證。