README
🚀 会议管理平台 MCP 集成指南
本指南详细介绍了会议管理平台 MCP 的集成和使用方法,涵盖与 Claude 桌面端的集成、开发环境配置、日志管理等关键功能。
🚀 快速开始
与 Claude 桌面端集成
按照以下步骤将会议管理平台 MCP 与 Claude 桌面端集成:
- 打开 Claude 应用。
- 进入设置界面。
- 选择“模型上下文协议”。
- 添加新的服务器配置:
- 名称:输入“会议管理平台 MCP”。
- 类型:选择“sse”。
- 服务地址:填写“http://localhost:7017/mcp”。
- 可选:添加身份验证所需的头信息。
📦 安装指南
构建项目
在项目根目录下执行以下命令来构建项目:
npm run build
💻 使用示例
使用 MCP 监控面板测试
使用以下命令运行 MCP 监控面板进行测试:
npm run inspect
开发模式(自动重启)
若要开启开发模式(自动重启),可执行:
npm run dev
日志管理
服务具备优化的日志功能,使用以下命令进行日志管理:
npm run cleanup
此命令的作用如下:
- 清理不必要的日志文件和缓存数据。
- 过滤掉重复的心跳信息。
- 减少磁盘占用,同时保留重要日志信息。
- 维持较小的日志 footprint 以适应长期运行的服务。
📚 详细文档
项目结构
本项目的结构如下:
src/index.ts:主程序入口。src/tools/:工具实现模块。src/resources/:资源定义文件夹。src/api/:后端 API 客户端。src/types/:TypeScript 类型定义。src/config.ts:服务配置文件。src/utils/:实用函数库。logging.ts:日志过滤与管理工具。tinyDb.ts:持久化机器人跟踪数据库。
身份验证
服务需要在“x-api-key”头中提供 API 密钥进行身份验证,您可以在配置文件中设置默认密钥。
此外,许多工具(以“WithCredentials”命名)可以直接接受 API 密钥作为参数,而无需通过头信息传递。
QR 码生成器 API 密钥配置
QR 码生成工具需要来自 QR Code AI API 的密钥,以下是几种提供方式:
- 直接在提示中输入:在使用
generateQRCode工具时,将 API 密钥直接包含在提示文本中,例如:“为我的网站 https://example.com 生成一个 QR 码,API 密钥:qrc_your_key_here”。 - 作为参数传递:在调用
generateQRCode工具时,提供apiKey参数。 - 环境变量:设置
QRCODE_API_KEY环境变量。 - Claude 桌面端配置:将密钥添加到您的 Claude 桌面端配置文件中:
- Mac/Linux 系统路径:
~/Library/Application Support/Claude/claude_desktop_config.json。 - Windows 系统路径:
%APPDATA%\Claude\claude_desktop_config.json。
- Mac/Linux 系统路径:
示例配置如下:
{
"headers": {
"x-api-key": "qrc_your_key_here"
}
}
⚠️ 重要提示
实际使用时,请将
qrc_your_key_here替换为您自己的 API 密钥。
📄 许可证
本项目采用 MIT 许可证。
Scan to contact