关键词

OpenAI工具调用函数调用MCP协议服务端示例

使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器示例，旨在演示如何将 MCP 协议应用于 OpenAI API。它包含一个简单的 MCP 服务器和一个客户端，展示了如何通过 MCP 服务器注册和调用工具，从而扩展语言模型的功能。

主要功能点

  • 工具注册与执行: 服务器端注册了一个名为 'calculate_sum' 的工具，用于计算两个数字的和。客户端可以请求服务器执行此工具。
  • OpenAI API 集成: 客户端使用 OpenAI API (gpt-3.5-turbo) 进行对话，并能根据服务器提供的工具信息，指示 OpenAI 调用这些工具。
  • SSE 传输协议: 服务器和客户端之间通过 SSE (Server-Sent Events) 协议进行通信，符合 MCP 服务器对多种传输协议的支持。
  • 简单示例: 项目提供了一个清晰且易于理解的 MCP 服务器和客户端的交互示例，方便开发者快速上手 MCP 协议。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/manekinekko/openai-mcp-example.git
cd openai-mcp-example
  2. 安装依赖 
    npm install
  3. 配置 OpenAI API 密钥 在项目根目录下创建 '.env' 文件，并添加您的 OpenAI API 密钥： 
    OPENAI_API_KEY=your_openai_api_key

服务器配置

本示例 MCP 服务器无需复杂的配置文件。

启动命令:

{
  "server name": "openai-mcp-example-server",
  "command": "npm run start:server",
  "args": [],
  "description": "启动 OpenAI MCP 示例服务器"
}

参数注释:

  • 'server name': 服务器的名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'npm run start:server' 执行 'package.json' 中定义的脚本。
  • 'args': 启动命令的参数，本示例无需额外参数，所以为空数组。
  • 'description': 服务器配置的描述信息，方便用户理解。

注意: 客户端需要知道服务器的地址才能连接。在本示例中，客户端代码 ('src/client.ts') 默认连接到 'http://localhost:4321/sse'。如果服务器地址或端口发生更改，需要相应地修改客户端代码中的连接地址。

基本使用方法

  1. 启动 MCP 服务器 在项目根目录下，运行以下命令启动服务器：

    npm run start:server

    服务器启动后，会监听 'http://localhost:4321' 端口。

  2. 启动 MCP 客户端 在另一个终端窗口中，同样在项目根目录下，运行以下命令启动客户端：

    npm run start:client

    客户端启动后，会自动连接到服务器，并发送一个查询请求 "What is the sum of 2 and 3?"。

  3. 查看结果 客户端和服务器的控制台会输出相应的日志信息。客户端最终会在控制台打印出工具调用的过程和最终结果。服务器端会显示接收到的工具调用请求和工具执行的日志。

信息

分类

开发者工具

访问项目