使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器示例,旨在演示如何构建一个能够响应 LLM 客户端请求的后端服务。该服务器提供了一个工具,允许 LLM 客户端搜索古兰经数据库(SQLite)中的经文。

主要功能点

  • 工具注册与执行: 服务器注册了一个名为 'search_words' 的工具,LLM 客户端可以调用此工具来搜索古兰经经文。
  • 数据访问: 服务器连接到本地的 SQLite 数据库 'quran.db',并执行 SQL 查询以检索经文数据。
  • MCP 协议支持: 使用 'fastmcp' 库构建,支持 MCP 协议,能够与 MCP 客户端进行通信。

安装步骤

  1. 创建项目目录并进入:
    uv init MCPDemo2
    cd MCPDemo2
  2. 创建并激活虚拟环境:
    uv venv
    .venv\Scripts\activate
  3. 安装依赖:
    uv add mcp[cli]
  4. 创建服务器文件: (如果仓库中没有 'server.py',则需要创建并复制仓库中的 'server.py' 代码)
    new-item server.py
    (将仓库中的 'server.py' 代码复制到新创建的 'server.py' 文件中)
  5. 下载 'quran.db' 数据库: (需要用户自行查找或创建包含古兰经数据的 'quran.db' 文件,并将其放置在 'MCPDemo2' 目录下,或修改 'server.py' 中的数据库路径)

服务器配置

以下是 'claude_desktop_config.json' 中配置 MCP 服务器的示例,适用于 MCP 客户端(如 Claude):

{
  "serverName": "SearchWords",
  "command": "python",
  "args": ["server.py"]
}

配置参数说明:

  • 'serverName': 服务器名称,需要与 'server.py' 中 'FastMCP()' 构造函数中定义的名称一致,本例中为 '"SearchWords"'。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 启动命令的参数,这里指定服务器脚本为 'server.py'。

将以上配置信息添加到您的 MCP 客户端配置中,客户端即可连接到此 MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器: 在 'MCPDemo2' 目录下,激活虚拟环境后,运行以下命令启动服务器:
    python server.py
  2. 配置 MCP 客户端: 在 MCP 客户端(例如 Claude 应用)中,根据上述 “服务器配置” 部分的说明,配置连接到该 MCP 服务器。
  3. 在 MCP 客户端中使用工具: 连接成功后,在 MCP 客户端中,您应该可以调用名为 'search_words' 的工具。例如,在 Claude 中,您可以指示 Claude 使用 'search_words' 工具来搜索古兰经经文,例如:'请使用 search_words 工具搜索关于 "faith" 的经文'。服务器会将搜索结果返回给客户端。

信息

分类

数据库与文件