项目简介
mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在通过自然语言接口,简化用户与 Chakra 数据库的交互。它允许用户使用 Claude 等 LLM 应用,以自然语言查询数据库、管理数据,并进行数据分析。
主要功能点
- 自然语言查询数据库: 支持使用自然语言查询 Chakra 数据库中的数据。
- 数据共享交互: 能够与订阅的数据共享进行交互,例如查询金融数据等。
- 数据库管理: 提供创建、更新和删除数据库表的功能(仓库代码中未体现,但README中Feature有提及,此处存疑)。
- MCP协议兼容: 实现了 MCP 协议,可以与任何兼容 MCP 协议的客户端(如 Claude Desktop)进行通信。
请注意: 该项目目前处于早期阶段,可能存在一些限制和待改进之处,例如每次使用服务器时可能需要显式授权访问。
安装步骤
使用 OpenTools 自动安装 (推荐)
- 安装 OpenTools 前置条件: 请参考 OpenTools 官方文档 安装 OpenTools 的 prerequisites。
- 运行 OpenTools 命令: 打开终端,运行以下命令即可自动安装 'chakra' 集成:
npx opentools@latest i chakra
手动安装
- 安装 Python 3.11+ 和 uv: 确保您的系统已安装 Python 3.11 或更高版本,并安装 'uv' 工具。macOS 用户可以使用 Homebrew 安装 uv:'brew install uv'。
- 配置 Claude Desktop: 编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'。
- macOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
- 添加 MCP 服务器配置: 在 'claude_desktop_config.json' 文件中的 '"mcpServers"' 字段下,添加以下 JSON 配置块。
参数说明:{ "mcpServers": { "chakra": { "command": "uvx", "args": ["chakra-mcp"], "env": { "db_session_key": "YOUR_DB_SESSION_KEY" } } } }- '"chakra"': 服务器名称,可以自定义,用于在 Claude Desktop 中引用。
- '"command": "uvx"': 启动服务器的命令,这里使用 'uvx' 运行器。
- '"args": ["chakra-mcp"]': 传递给 'uvx' 运行器的参数,指定运行 'chakra-mcp' 模块。
- '"env"': 环境变量配置。
- '"db_session_key": "YOUR_DB_SESSION_KEY"': 必须替换为您的 Chakra 数据库 Session Key。 Session Key 获取步骤请参考 README.md 中的 "Finding your DB Session Key" 部分。
服务器配置
MCP 服务器配置信息 ( 'claude_desktop_config.json' ) 如下:
{ "mcpServers": { "chakra": { "command": "uvx", "args": ["chakra-mcp"], "env": { "db_session_key": "YOUR_DB_SESSION_KEY" } } } }
配置参数说明:
- server name: 'chakra' (服务器名称,用户自定义,用于在 Claude Desktop 中引用此服务器)
- command: 'uvx' (启动服务器的命令,使用 'uvx' 运行器)
- args: '["chakra-mcp"]' (传递给 'uvx' 的参数,指定运行 'chakra-mcp' 模块)
- env: 环境变量配置
- db_session_key: 'YOUR_DB_SESSION_KEY' (Chakra 数据库 Session Key,请务必替换为您的真实 Session Key)
基本使用方法
- 启动 Claude Desktop: 确保已安装并启动 Claude Desktop 客户端。
- 在 Claude 中使用 @ 引用 MCP 服务器: 在 Claude 的对话框中,可以使用 '@chakra'(或您在 'claude_desktop_config.json' 中配置的服务器名称)来触发 MCP 服务器的功能。
- 自然语言交互: 使用自然语言向 Claude 提出关于 Chakra 数据库的问题或指令。例如:
- '@chakra 初始化连接并查看数据库元数据'
- '@chakra 查询特斯拉的股票价格' (假设您的数据库中有相关数据表)
- '@chakra 执行 SQL 查询 "SELECT * FROM your_table LIMIT 10"' (请替换 'your_table' 为实际表名,并注意SQL语法的DuckDB兼容性,如需使用LIKE操作符请使用小写文本和列名)
注意: 首次使用 MCP 服务器时,Claude Desktop 可能会请求您授权访问,请根据提示进行授权。
通过以上步骤,您就可以使用 mcp-server 连接到 Chakra 数据库,并使用自然语言进行数据查询和交互了。
信息
分类
数据库与文件