关键词

工具扩展提示模板LLM应用上下文服务JSON-RPC

ChatData MCP 服务器使用说明

项目简介

ChatData MCP 服务器是一个基于 Model Context Protocol (MCP) 的后端服务，旨在增强大型语言模型（LLM）的功能。它通过提供丰富的工具集和灵活的提示系统，使得 LLM 能够执行更复杂的任务，并更好地理解和处理上下文信息。

主要功能点

  • 工具系统: 内置多种实用工具，包括：
    • 网络工具: 网页抓取、IP信息查询、HTTP客户端等，帮助 LLM 获取网络数据。
    • 数据处理工具: 数据格式转换、文本摘要、数学计算等，增强 LLM 的数据处理能力。
    • 开发辅助工具: 代码格式化、数据库查询等，辅助 LLM 进行软件开发相关任务。
    • 多媒体工具: 图像生成，扩展 LLM 的多媒体处理能力。
    • 通用工具: 文本翻译、天气查询、回显工具等，提供日常实用功能。
  • 提示系统: 预置多种提示模板，例如基本提示、内容生成、代码审查等，方便用户快速启动 LLM 任务，并支持自定义提示模板。
  • 灵活的通信方式: 支持标准输入/输出 (stdio) 和服务器发送事件 (SSE) 两种通信模式，可以根据不同的应用场景选择合适的模式。
  • 自动发现工具和提示: 服务器能够自动检测并注册 'tools/' 和 'prompts/' 目录下新增的工具和提示，方便扩展和维护。

安装步骤

  1. 安装 Python 3.12 或更高版本：推荐使用 Python 3.12 以获得最佳兼容性。
  2. 创建虚拟环境： 
    uv venv --python 3.12
  3. 激活虚拟环境：请根据您的操作系统选择激活虚拟环境的命令。
  4. 安装依赖： 
    pip install -e .
    或者使用 'uv' 加速安装： 
    uv pip install -e .
  5. 安装 Playwright: 部分工具（如 'browser_use'）依赖 Playwright，如果需要使用相关工具，请安装 Playwright 浏览器驱动： 
    playwright install

服务器配置

MCP客户端需要配置以下 JSON 信息以连接到 ChatData MCP 服务器。以下是针对 stdio 模式的配置示例：

{
  "serverName": "chatdata-mcp-server",  // MCP 服务器名称，可以自定义
  "command": "server",                 // 启动服务器的命令，这里是 'server'
  "args": []                          // 启动命令的参数，stdio 模式无需参数
}

参数说明:

  • 'serverName': MCP 服务器的名称，客户端用以识别和管理不同的 MCP 服务器连接。可以根据需要自定义。
  • 'command': 启动 MCP 服务器的可执行命令。在本项目中，直接使用 'server' 命令 (对应 'main.py' 入口)。
  • 'args': 启动命令的参数列表。对于 stdio 模式，通常不需要额外的启动参数，因此为空列表 '[]'。

如果使用 SSE 模式，则需要配置端口和传输协议：

{
  "serverName": "chatdata-mcp-server-sse", // SSE 模式服务器名称，可以自定义
  "command": "server",                      // 启动命令仍然是 'server'
  "args": ["--transport", "sse", "--port", "8000"] // 启动参数，指定 SSE 传输和端口
}

SSE 模式参数说明:

  • '--transport sse': 指定使用 SSE 传输协议。
  • '--port 8000': 指定 SSE 服务器监听的端口为 8000。您可以根据需要修改端口号。

基本使用方法

  1. 启动服务器：
    • stdio 模式 (默认)：在虚拟环境激活的状态下，直接运行命令 'server' 即可启动服务器。 
      server
    • SSE 模式：使用以下命令启动 SSE 模式服务器，并指定端口（例如 8000）： 
      server --transport sse --port 8000
  2. MCP 客户端连接: 配置您的 MCP 客户端，使其连接到 ChatData MCP 服务器。对于 stdio 模式，客户端通常会直接通过管道与服务器进程通信。对于 SSE 模式，客户端需要连接到 'http://服务器地址:端口/sse' (例如 'http://localhost:8000/sse')。
  3. 使用工具和提示: MCP 客户端连接成功后，即可通过 MCP 协议调用服务器提供的工具和提示，以增强 LLM 的功能。

工具列表: 所有工具都位于 'tools/' 目录下，每个工具都有详细的描述和参数定义。您可以通过 MCP 客户端的工具列表功能查看可用工具及其使用方法。

提示模板列表: 所有提示模板都位于 'prompts/' 目录下，您可以根据需要选择合适的提示模板，或自定义新的提示模板。

开发指南: 如果您需要添加新的工具或提示，请参考 'README.md' 中的 "开发指南" 章节，按照示例创建新的 Python 文件，并在 'get_tools()' 或 'get_prompts()' 函数中注册您的工具或提示。

注意: 部分工具可能需要额外的环境变量配置，例如 OpenAI API 密钥等。请参考工具的具体说明或代码注释进行配置。

信息

分类

AI与计算

访问项目