README
🚀 项目介绍 - Mattermost集成的MCP服务器
本项目实现了Mattermost集成的模型上下文协议(MCP)服务器。它能连接到Mattermost API端点,检索并处理各类信息,再通过标准MCP传输方式将这些信息提供出来,为Mattermost的使用带来了更强大的功能和便利。
✨ 主要特性
- 🔗 可连接到Mattermost API端点,轻松获取所需信息。
- 🌟 支持多种传输模式:
- SSE(服务器发送事件):实现实时消息的高效传输。
- 标准I/O:提供灵活的数据交互方式。
- 💬 实时消息处理,确保信息及时响应。
- 👥 团队和频道特定监控,精准关注重点内容。
- 🔐 基于令牌的安全认证,保障系统安全。
📦 安装指南
环境要求
- Node.js >= 22
- npm >= 10
安装步骤
- 克隆此仓库:
git clone https://github.com/kakehashi-inc/mattermost-mcp-server.git
cd mattermost-mcp-server
- 安装依赖项:
npm install
- 构建服务器:
npm run build
💻 使用示例
该服务器支持两种传输模式:
基础用法 - SSE传输模式
npm start -- --endpoint="https://your-mattermost-server" \
--token="your-mattermost-token" \
--team-id="your-team-id" \
--channels="channel1,channel2" \
--port 8202
高级用法 - 标准I/O传输模式
npm start -- --endpoint="https://your-mattermost-server" \
--token="your-mattermost-token" \
--team-id="your-team-id" \
--channels="channel1,channel2" \
--stdio
必要参数
| 属性 | 详情 |
|------|------|
| endpoint | 您的Mattermost服务器URL |
| token | 您的Mattermost身份验证令牌 |
| team-id | 要监控的团队ID |
| channels | 逗号分隔的目标频道名称列表 |
可选参数
| 属性 | 详情 |
|------|------|
| port | SSE传输模式使用的端口号(默认:8202) |
| stdio | 启用标准I/O传输模式的标志 |
📚 详细文档
开发工作
npm run dev:以开发模式启动服务器,带有热重载功能,方便开发调试。npm run lint:运行ESLint进行代码检查,确保代码质量。npm run format:使用Prettier格式化代码,统一代码风格。npm test:执行测试用例,保证系统稳定性。npm run inspect:运行MCP检测工具,进行相关检测。
📄 许可证
本项目采用MIT许可证。
Scan to contact