使用说明
项目简介
本项目是一个基于Model Context Protocol (MCP) 构建的服务器,旨在通过一组工具向LLM客户端提供对QuickBooks Time 数据的访问能力。它整合了多个独立服务器的功能,统一提供工单代码、时间表、用户、项目和报表等信息的查询和检索能力。
主要功能点
- 数据访问工具: 提供多种工具,用于检索和过滤 QuickBooks Time 中的各种数据,例如:
- 工单代码 (Job Codes)
- 时间表 (Timesheets)
- 用户 (Users)
- 项目 (Projects)
- 报表 (Reports)
- 自定义字段 (Custom Fields)
- 通知 (Notifications)
- 客户 (Managed Clients)
- 标准 MCP 协议: 遵循 Model Context Protocol 标准,使用 JSON-RPC 协议与客户端通信,易于集成到支持 MCP 协议的 LLM 应用中。
- 灵活的过滤选项: 每个工具都提供了丰富的参数选项,允许用户根据ID、名称、日期、状态等多种条件进行数据过滤和查询。
- 基于标准输入/输出 (stdio) 运行: 服务器通过标准输入接收请求,并通过标准输出返回响应,方便部署和集成。
安装步骤
- 安装依赖: 确保你的系统已安装 Python 和 pip,然后在终端中导航到 'qb-time-mcp-server' 目录,并运行以下命令安装项目依赖:
pip install -r requirements.txt - 配置环境变量: 在 'qb-time-mcp-server' 目录下创建 '.env' 文件,并添加你的 QuickBooks Time 访问令牌。请替换 'your_access_token_here' 为你实际的访问令牌。
QB_TIME_ACCESS_TOKEN=your_access_token_here NODE_ENV=development
服务器配置
为了让 MCP 客户端(例如 Claude Desktop)连接到此服务器,你需要配置客户端的服务器设置。以下是一个示例配置,你需要将其添加到你的 MCP 客户端配置中:
{ "server name": "qb-time-tools", "command": "python", "args": [ "./qb-time-mcp-server/main.py" ] }
- 'server name': 为你的服务器指定一个名称,这个名称将显示在你的 MCP 客户端中,你可以自定义设置。
- 'command': 指定启动服务器的命令。通常设置为 'python',表示使用 Python 解释器来运行脚本。
- 'args': 一个字符串数组,包含传递给 'command' 的参数。这里指定了服务器主脚本的路径 './qb-time-mcp-server/main.py'。请根据你的 MCP 客户端的工作目录调整脚本路径。
基本使用方法
- 启动服务器: 在 MCP 客户端中配置好服务器信息后,启动该 MCP 服务器。服务器将开始监听来自客户端的 JSON-RPC 请求。
- 客户端调用工具: 在你的 MCP 客户端中,你可以使用预定义的工具名称(例如 'get_jobcodes', 'get_timesheets' 等,详细工具列表请参考仓库的 'README.md' 文件或 'server.py' 文件中的 'SERVER_INFO' 变量)来调用服务器提供的功能。
- 参数传递: 根据每个工具的 'inputSchema' 定义,以 JSON 格式向工具传递必要的参数,以获取 QuickBooks Time 中的数据。
信息
分类
商业系统