使用说明

项目简介

Simple OpenAI Assistant MCP服务器是一个基于Model Context Protocol (MCP) 的服务器实现，旨在简化与OpenAI Assistants API的集成。它允许MCP客户端（如Claude Desktop）通过标准化的MCP协议，方便地创建、配置和使用OpenAI助手，从而构建更强大的AI应用。

主要功能点

助手管理: 支持创建、列出、检索和更新OpenAI助手，方便用户根据需求定制和管理不同的助手。
对话管理: 支持创建新的对话线程，并在线程中与指定的助手进行多轮对话。
消息处理: 允许客户端向助手发送消息，并异步获取助手的回复，应对OpenAI API响应延迟的问题。
工具集成: 通过MCP协议将OpenAI Assistants API的功能封装为一系列易于调用的工具，供客户端使用。

安装步骤

确保已安装Python 3.10或更高版本。

使用pip安装：

pip install mcp-simple-openai-assistant

服务器配置

要使MCP客户端（例如Claude Desktop）能够连接到Simple OpenAI Assistant MCP服务器，您需要在客户端的配置文件中添加服务器配置信息。以下是配置示例，您需要根据您的实际环境进行调整。

Claude Desktop 配置示例 (MacOS):

{
  "mcpServers": {
    "openai-assistant": {
      "command": "python",
      "args": ["-m", "mcp_simple_openai_assistant"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here"  // 替换为您的OpenAI API密钥
      }
    }
  }
}

Claude Desktop 配置示例 (Windows):

{
  "mcpServers": {
    "openai-assistant": {
      "command": "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\Python\\Python311\\python.exe", // 替换为您的Python可执行文件路径
      "args": ["-m", "mcp_simple_openai_assistant"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here"  // 替换为您的OpenAI API密钥
      }
    }
  }
}

配置参数说明:

'"openai-assistant"': 服务器名称，客户端用此名称引用该服务器。可以自定义。
'"command"': 启动服务器的命令。通常为 'python' 或 Python 可执行文件的完整路径。
'"args"': 传递给 'command' 的参数。 '["-m", "mcp_simple_openai_assistant"]' 表示以模块方式运行 'mcp_simple_openai_assistant'。
'"env"': 环境变量配置。
- '"OPENAI_API_KEY"': 必需配置，您的OpenAI API密钥。请替换 '"your-api-key-here"' 为您的实际密钥。

注意:

Windows 用户的 Python 可执行文件路径可能需要根据实际安装情况进行调整。可以使用 'where python' 命令在命令提示符中查找 Python 路径。
确保 'OPENAI_API_KEY' 环境变量已正确设置，否则服务器将无法连接到OpenAI API。

基本使用方法

配置完成后，MCP客户端将可以通过以下工具与OpenAI助手进行交互：

创建助手 (create_assistant): 创建一个新的OpenAI助手，可以指定助手的名称、指令和模型。
列出助手 (list_assistants): 获取已创建的助手列表，方便查看和选择助手。
检索助手 (retrieve_assistant): 获取特定助手的详细信息，例如配置和指令。
更新助手 (update_assistant): 修改已创建的助手的配置，例如名称、指令或模型。
创建线程 (new_thread): 为对话创建一个新的线程，线程用于管理对话的上下文。
发送消息 (send_message): 向指定助手和线程发送用户消息，启动助手处理。
检查回复 (check_response): 检查助手是否已生成回复。由于OpenAI API的异步特性，回复可能需要一段时间才能准备好，客户端需要轮询此工具来检查回复状态。

客户端根据自身的功能和界面，调用这些工具来实现与OpenAI助手的交互。具体工具的参数和使用方式请参考仓库中 'mcp_simple_openai_assistant/tools.py' 文件的 'get_tool_definitions' 函数的定义。

关键词