关键词

Vonage API文档搜索代码助手开发者工具知识库

使用说明

项目简介

Vonage AI 代码助手服务器是一个基于 Model Context Protocol (MCP) 的后端服务，旨在帮助开发者更便捷地访问 Vonage API 文档。它通过提供名为 'Vonage-Assist' 的工具，允许LLM客户端搜索 Vonage 官方文档，从而辅助开发者快速找到所需的 API 信息和代码示例。该服务器利用 FastMCP 框架构建，并集成了 Google Serper API 用于文档搜索。

主要功能点

  • Vonage 文档检索: 提供 'Vonage-Assist' 工具，允许用户通过自然语言查询 Vonage API 文档。
  • 关键词搜索: 支持关键词搜索，例如 "number verification", "SMS API" 等，快速定位相关文档。
  • 内容提取: 从搜索结果链接中提取文档内容，并返回给 LLM 客户端。
  • MCP 协议兼容: 遵循 MCP 协议，可与 Claude 等支持 MCP 协议的 LLM 客户端无缝集成。

安装步骤

  1. 安装 Python 3.13+: 确保已安装 Python 3.13 或更高版本。
  2. 设置环境变量: 配置 Google Serper API 密钥 'SERPER_API_KEY'。您需要在 Serper.dev 获取 API 密钥。 
    export SERPER_API_KEY="YOUR_SERPER_API_KEY"
    或者将 'SERPER_API_KEY=YOUR_SERPER_API_KEY' 添加到 '.env' 文件 (项目根目录下)。
  3. 安装依赖: 使用 uv 安装项目依赖。 
    uv install
  4. 运行服务器: 启动 Vonage AI 代码助手 MCP 服务器。 
    python main.py

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 Vonage AI 代码助手服务器：

{
  "serverName": "VonageAssistServer",
  "command": "python",
  "args": ["main.py"]
}

配置参数说明:

  • 'serverName': 服务器名称，可以自定义，例如 "VonageAssistServer"。
  • 'command': 启动服务器的命令，这里使用 'python' 解释器。
  • 'args': 传递给 'python' 命令的参数，即服务器启动脚本 'main.py'。

注意:

  • 确保在运行 MCP 客户端的环境中，'SERPER_API_KEY' 环境变量已正确设置，或者 '.env' 文件与 'main.py' 在同一目录下。
  • 客户端需要能够访问到 'python' 命令以及 'main.py' 脚本。如果 'python' 不在系统 PATH 环境变量中，您可能需要指定 'python' 的完整路径。

基本使用方法

服务器启动后，LLM 客户端可以通过 MCP 协议调用 'Vonage-Assist' 工具。

工具名称: 'Vonage-Assist'

工具参数:

  • 'query': 搜索关键词，例如 "number verification", "SMS API"。
  • 'library': 文档库，目前仅支持 '"vonage"'。

示例:

在支持 MCP 协议的 LLM 客户端中，可以使用如下指令调用 'Vonage-Assist' 工具：

Use the Vonage-Assist tool to find information about implementing two-factor authentication with Vonage APIs.

客户端会将上述指令转换为 MCP 请求发送给服务器，服务器执行文档搜索并返回结果。

信息

分类

开发者工具

访问项目