使用说明
项目简介
本项目是一个 Model Context Protocol (MCP) 服务器的演示示例,它使用 SQLite 数据库来存储和管理数据。该服务器允许支持 MCP 协议的 LLM 客户端(如 Claude Desktop)连接到该服务器,并查询 SQLite 数据库中的信息。本示例主要展示了如何通过 MCP 服务器将本地数据资源以标准化的方式提供给 LLM 应用使用。
主要功能点
- SQLite 数据库集成: 使用 SQLite 数据库作为数据存储,演示如何通过 MCP 服务器访问和查询数据库资源。
- 产品信息查询: 预置了一个包含产品信息的 SQLite 数据库,LLM 客户端可以查询产品名称和价格等信息。
- Claude Desktop 集成演示: 提供了详细的 Claude Desktop 配置步骤,指导用户如何将该 MCP 服务器添加到 Claude Desktop 中使用。
- 简单的资源访问示例: 通过预定义的数据库和数据表,演示了 MCP 服务器最核心的资源管理和数据访问能力。
安装步骤
-
安装必备软件: 确保你的电脑上已安装以下软件,如果未安装请根据 README.md 文件中的指引进行安装:
- macOS 或 Windows 操作系统
- Claude Desktop 最新版本 (用于测试 MCP 服务器连接)
- uv (包管理器)
- Git
- SQLite 对于 Windows 用户,可以使用 'winget' 或手动下载安装;macOS 用户可以使用 'brew' 安装。
-
安装 Python 依赖: 打开终端或命令提示符,导航到项目根目录(假设你已经下载或克隆了该仓库),运行以下命令安装 Python 依赖:
pip install uv uv pip install -r requirements.txt注意:实际上仓库中没有 'requirements.txt' 文件,根据 README 指引,可能需要手动创建或者此步骤可以跳过,因为示例代码依赖较少。如果运行 'uv pip install -r requirements.txt' 报错,可以尝试跳过此步骤。
-
创建 SQLite 数据库: 在项目根目录下,运行 'create_db.py' 脚本创建 SQLite 数据库 'test.db' 并初始化数据:
python create_db.py运行成功后,会在项目根目录下生成 'test.db' 文件。
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),你需要提供服务器的启动命令和参数。以下是针对 Claude Desktop 的 SQLite 服务器配置示例,你需要将配置信息添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。
SQLite 服务器配置信息 (JSON 格式):
{ "mcpServers": { "sqlite": { "command": "uvx", "args": [ "mcp-server-sqlite", "--db-path", "FULL_PATH_TO_YOUR_test.db" ] } } }
配置参数说明:
- '"sqlite"': 服务器名称,可以自定义,在 Claude Desktop 中用于标识该服务器。
- '"command": "uvx"': 指定启动服务器的命令。 'uvx' 是 'uv' 包管理器提供的命令运行器,用于运行 Python 应用或脚本。
- '"args"': 启动参数列表,包含以下参数:
- '"mcp-server-sqlite"': 推测是实际运行的服务器脚本或模块名称 (但仓库中未直接提供此文件,可能需要用户自行安装或构建,或者 Claude Desktop 内部集成了此 'mcp-server-sqlite' 命令,此处配置可能仅为示例,实际使用需根据 Claude Desktop 文档或 MCP 服务器的具体实现调整)。
- '"--db-path"': 指定 SQLite 数据库文件路径的参数。
- '"FULL_PATH_TO_YOUR_test.db"': 请将 'FULL_PATH_TO_YOUR_test.db' 替换为你电脑上 'test.db' 文件的完整路径。例如,如果 'test.db' 文件在 'D:\Projects\model-context-protocol-demo' 目录下,则应替换为 '"D:\Projects\model-context-protocol-demo\test.db"'。
Claude Desktop 配置文件位置:
- Windows: '%APPDATA%\Claude\claude_desktop_config.json'
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
配置步骤:
- 打开 Claude Desktop 配置文件 'claude_desktop_config.json'。
- 在 'claude_desktop_config.json' 文件中找到 '"mcpServers"' 字段(如果不存在则手动创建)。
- 将上面的 SQLite 服务器配置信息 (JSON 格式) 代码段添加到 '"mcpServers"' 字段中。
- 务必将 '"FULL_PATH_TO_YOUR_test.db"' 替换为正确的数据库文件路径。
- 保存 'claude_desktop_config.json' 文件。
- 重启 Claude Desktop 使配置生效。
基本使用方法
- 启动 Claude Desktop 客户端。
- 点击聊天输入框旁边的 🔌 (插件) 图标。
- 在弹出的插件面板中,展开 "Installed MCP Servers" (已安装的 MCP 服务器) 部分。
- 确认你配置的 "sqlite" 服务器是否显示在列表中,并且状态为已连接或可用。
- 在 Claude Desktop 的聊天输入框中,尝试向 Claude 提问,例如: 'Can you connect to my SQLite database and tell me what products are available, and their prices?' 或中文: '你能连接到我的SQLite数据库,告诉我有哪些产品以及它们的价格吗?'
- 如果配置正确,Claude 应该能够连接到你的 SQLite 数据库,并根据你的问题返回产品信息。
注意: 此示例仓库主要用于演示 MCP 服务器的概念和集成方式,可能不包含完整的 'mcp-server-sqlite' 服务器代码实现。实际运行可能依赖于 Claude Desktop 内置的 MCP 服务器运行时环境或需要用户自行安装额外的 MCP 服务器组件。请参考 Claude Desktop 或 MCP 协议的官方文档获取更详细的服务器实现和部署信息。
信息
分类
数据库与文件