关键词

Payman AI文档API参考SDK集成指南

项目简介

Payman文档MCP服务器是一个基于 Model Context Protocol (MCP) 的后端应用，旨在为AI助手（如Claude、Cursor等）提供Payman AI 官方文档的访问能力。通过部署此服务器，开发者可以使AI助手更有效地理解和解答关于 Payman AI 产品集成的问题。

主要功能点

  • 文档检索: 支持按主题检索 Payman AI 文档内容。
  • 关键词搜索: 允许在 Payman AI 文档中进行关键词搜索，快速定位相关信息。
  • 代码示例: 提供 Node.js 和 Python 两种语言的 Payman AI 集成代码示例。
  • 问题解答: 针对常见的 Payman AI 集成问题提供排查和解决建议。
  • SDK 帮助: 提供 Payman AI Node.js 和 Python SDK 的使用帮助。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/PaymanAI/payman-doc-mcp-server
  2. 进入项目目录: 
    cd payman-doc-mcp-server
  3. 安装依赖: 
    npm install
# 或
yarn install
  4. 构建项目: 
    npm run build
# 或
yarn build

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 Payman 文档 MCP 服务器。请注意，您需要将 '[项目绝对路径]' 替换为 'payman-doc-mcp-server' 项目在您本地文件系统中的绝对路径。

{
  "serverName": "payman-mcp",
  "command": "node",
  "args": ["[项目绝对路径]/build/index.js"]
}

配置参数说明:

  • 'serverName': 服务器名称，这里设置为 "payman-mcp"。
  • 'command': 启动服务器的命令，这里使用 'node' 解释器。
  • 'args': 命令参数，指向编译后的服务器入口文件 'index.js' 的绝对路径。

请务必将 '[项目绝对路径]' 替换为实际路径，否则MCP客户端将无法找到并启动服务器。

基本使用方法

  1. 启动服务器: 无需手动启动服务器，MCP 客户端会根据您提供的配置信息自动启动。
  2. 配置 MCP 客户端: 在您的 MCP 客户端（例如 Claude、Cursor）中，添加新的 MCP 服务器连接，并填入上述 JSON 配置信息。
  3. 使用 AI 助手: 在 AI 助手中，您可以指示其使用以下工具来访问 Payman AI 文档：
    • 'get-documentation': 获取指定主题的文档。
    • 'search-documentation': 在文档中搜索关键词。
    • 'get-code-examples': 获取代码示例。
    • 'solve-problem': 寻求问题解答。
    • 'get-sdk-help': 获取 SDK 使用帮助。

例如，您可以对 Claude 或 Cursor 说： "使用 'get-documentation' 工具获取 'quickstart' 主题的 Payman AI 文档" 或 "使用 'search-documentation' 工具搜索关于 'API Keys' 的信息"。

信息

分类

开发者工具

访问项目