JinDaGe - mcp-server-mattermost MCP Details

article

README

🚀 mattermost-mcp-server 项目

本项目实现了一个与 Mattermost 集成的 Model Context Protocol (MCP) 服务器。它能够连接到 Mattermost API 端点，检索并处理各类信息，还能通过标准 MCP 传输方式提供这些信息，为 Mattermost 的信息交互提供了高效的解决方案。

🚀 快速开始

本项目实现的 Mattermost 集成 MCP 服务器，可连接到 Mattermost API 端点，通过标准 MCP 传输方式提供信息。下面将详细介绍使用步骤。

✨ 主要特性

API 连接：可连接到 Mattermost API 端点。
多传输模式：支持服务器发送事件（SSE）和标准输入输出（I/O）两种传输模式。
实时处理：具备实时消息处理能力。
特定监控：可对团队和频道进行特定监控。
安全认证：采用基于令牌的安全认证机制。

📦 安装指南

环境需求

Node.js >= 22
npm >= 10
dotenvx
- dotenvx

安装步骤

克隆此仓库：

git clone https://github.com/kakehashi-inc/mattermost-mcp-server.git
cd mattermost-mcp-server

安装依赖项：

npm install

设置环境变量：

# 创建 .env 文件
cp .env.example .env

# 加密你的 .env 文件（生产环境中推荐）
dotenvx encrypt

所需环境变量： | 属性 | 详情 | |------|------| | MCP_PORT | SSE 传输模式的端口号（默认：8201） | | MATTERMOST_ENDPOINT | 你的 Mattermost 服务器 URL | | MATTERMOST_TOKEN | 你的 Mattermost 认证令牌 | | MATTERMOST_TEAM_ID | 要监控的团队 ID | | MATTERMOST_CHANNELS | 要监控的频道名称列表（以逗号分隔） |

构建服务器：

npm run build

💻 使用示例

基础用法

本服务器支持两种传输模式，以下是启动示例：

SSE 传输模式

npm start

标准 I/O 传输模式

npm start -- --stdio

📚 详细文档

开发相关命令

npm run dev：以开发模式启动服务器，带有热重载功能。
npm run lint：运行 ESLint。
npm run format：使用 Prettier 格式化代码。
npm test：运行测试。
npm run inspect：运行 MCP 检查工具。

参考资料

📄 许可证

本项目采用 MIT 许可证。

mcp-server-mattermost