返回 MCP 目录
public公开dns本地运行

mattermost-mcp-server

该项目实现了一个Mattermost的MCP服务器,用于集成Mattermost API并支持多种传输模式,包括SSE和标准I/O,提供实时消息处理和团队频道监控功能。

article

README

🚀 mattermost - mcp - server项目

此项目实现了一个与Mattermost集成的模型上下文协议(MCP)服务器。它能够连接到Mattermost API端点,获取并处理各类信息,同时通过标准MCP传输将这些信息提供出来,为用户提供了便捷的信息交互体验。

🚀 快速开始

本项目实现的Mattermost集成的模型上下文协议(MCP)服务器,能让你方便地连接Mattermost API获取和处理信息。下面为你介绍快速开始的步骤。

✨ 主要特性

  • 可连接到Mattermost API端点,轻松获取所需信息。
  • 支持多种传输方式:
    • SSE(服务器发送事件),实现实时消息推送。
    • 标准I/O,提供灵活的数据交互途径。
  • 具备实时消息处理能力,及时响应消息变化。
  • 支持团队和频道特定监控,精准关注重点内容。
  • 采用基于令牌的安全认证,保障系统安全。

📦 安装指南

环境要求

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

安装步骤

  1. 克隆此仓库:
git clone https://github.com/kakehashi-inc/mattermost-mcp-server.git
cd mattermost-mcp-server
  1. 安装依赖项:
npm install
  1. 设置环境变量:
# 创建.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 | 逗号分隔的频道名称列表,用于监控 |

  1. 构建服务器:
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许可证。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端