TimeTime MCP 服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,旨在帮助大型语言模型 (LLM) 客户端(如AI Agent)与 TimeTime 预约和排班服务进行交互。它通过标准的MCP接口,向LLM客户端暴露TimeTime API的能力。
项目简介
该项目实现了一个简单的MCP服务器,作为AI Agent访问TimeTime API的桥梁。它封装了TimeTime的RESTful API,并将其功能转换为LLM可理解和调用的MCP工具。
主要功能点
- API 访问工具: 暴露TimeTime API的各项操作,LLM可以通过调用这些工具来执行API请求。
- API 文档查询: 提供工具来查询TimeTime API的元信息、端点文档、错误码和Schema定义,帮助LLM理解API结构和使用方法。
- 代码示例生成: 提供工具为特定API端点生成代码示例,辅助LLM或开发者集成。
- 预约排班管理: 通过封装的API工具,LLM可以间接实现创建、查询、更新和取消预约,管理资源、事件类型、日历等。
- 多语言支持: 支持通过API参数获取多语言内容(依赖TimeTime API自身)。
安装步骤
- 确保已安装 Node.js 环境。
- 克隆仓库到本地:
git clone https://github.com/timetime-software/timetime-mcp.git cd timetime-mcp - 安装项目依赖:
npm ci - 项目构建好的可执行文件位于 '/dist' 目录中。
服务器配置 (针对 MCP 客户端)
MCP客户端需要配置如何启动该MCP服务器进程。通常需要以下配置信息(JSON格式),具体字段名和结构可能因客户端实现而异,但核心是指定启动命令和参数:
{ "name": "timetime-mcp", // MCP服务器的名称 "command": "node", // 启动服务器的命令,例如 node 或完整的路径 "args": [ // 传递给命令的参数,这里指定服务器入口文件 "<path-to-the-repo>/dist/index.js" // 替换为 timetime-mcp 仓库在你本地文件系统中的完整路径 ], // 其他可能的配置项,如 transport 类型,通常默认是 stdio "transport": { "type": "stdio" } }
请根据你的MCP客户端的配置界面或文件格式,填写相应的服务器名称、启动命令(通常是'node')和服务器入口文件路径。
基本使用方法
- 确保已按照上述步骤安装并配置了MCP服务器。
- 启动你的MCP客户端,客户端会自动尝试连接和启动配置好的TimeTime MCP服务器。
- 一旦服务器成功启动并连接(客户端界面通常会有指示,如绿点),LLM Agent即可通过MCP协议调用服务器暴露的工具和Prompt。
- LLM Agent可以通过调用名为 'start' 的工具来获取关于如何使用该服务器的基本信息和指南。
- 多数API调用工具(如 'run')需要提供 TimeTime API Key 进行认证。LLM Agent可能需要向用户询问此API Key。用户可以在 TimeTime Web 应用的开发者设置中生成 API Key:'https://app.timetime.in/dashboard/profile/developers'。
- LLM Agent可以使用 'get-meta', 'get-endpoint-docs', 'get-schema-definition', 'get-error-codes' 等工具来探索TimeTime API的详细信息,从而更好地构建API调用请求。
- LLM Agent可以使用 'run' 工具直接执行TimeTime API的HTTP请求,传递API路径、方法、请求体和API Key。
信息
分类
生产力应用