Mattermost MCP 服务器使用说明

项目简介

Mattermost MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的服务器端应用，它连接到 Mattermost API 接口，并将 Mattermost 中的团队和频道消息数据转换为 MCP 协议定义的资源，为 LLM（大型语言模型）客户端提供结构化的上下文信息。通过注册工具和 Prompt 模板，该服务器允许 LLM 客户端检索 Mattermost 消息，从而增强 LLM 在 Mattermost 环境中的应用能力。

主要功能点

Mattermost 数据桥接: 连接 Mattermost API，将 Mattermost 平台的消息数据接入 MCP 生态。
上下文信息提供: 通过 MCP 协议向 LLM 客户端提供 Mattermost 消息作为上下文资源。
工具注册与执行: 提供工具 (Tool) 功能，允许 LLM 客户端调用工具检索 Mattermost 消息，支持关键词搜索和消息数量限制。
Prompt 模板支持: 提供 Prompt 模板功能，支持 LLM 客户端通过预定义的 Prompt 模板获取格式化的 Mattermost 消息，用于对话或信息整合。
多种传输协议: 支持 SSE (Server-Sent Events) 和 Standard I/O 两种 MCP 传输协议，方便不同场景下的客户端连接。
安全认证: 采用基于 Token 的认证机制，保障数据访问安全。

安装步骤

克隆仓库:

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

安装依赖:
```
npm install
```

配置环境变量:

复制 '.env.example' 文件并重命名为 '.env':

cp .env.example .env

编辑 '.env' 文件，根据您的 Mattermost 环境配置以下环境变量：

MCP_PORT=8201                      # SSE 传输模式端口 (默认: 8201)
MATTERMOST_ENDPOINT=<Your Mattermost Server URL>   # Mattermost 服务器 URL
MATTERMOST_TOKEN=<Your Mattermost Authentication Token>    # Mattermost 认证 Token
MATTERMOST_TEAM_ID=<Your Mattermost Team ID>      # Mattermost 团队 ID
MATTERMOST_CHANNELS=<channel1_name,channel2_name> # 要监控的频道名称列表，逗号分隔

注意: 建议在生产环境中使用 'dotenvx encrypt' 命令加密 '.env' 文件以提高安全性。

构建服务器:
```
npm run build
```

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能建立连接。以下是 Mattermost MCP 服务器的配置信息，请根据您选择的传输模式进行配置：

SSE 传输模式配置:

{
  "server name": "mattermost-mcp-server",
  "command": "npm",
  "args": ["start"]
}

Standard I/O 传输模式配置:

{
  "server name": "mattermost-mcp-server",
  "command": "npm",
  "args": ["start", "--", "--stdio"]
}

参数注释:

'server name': 服务器名称，可自定义。
'command': 启动服务器的命令，这里使用 'npm'。
'args': 传递给 'npm' 命令的参数数组。
- SSE 模式: '["start"]' 运行 'npm start' 启动 SSE 模式服务器。
- Stdio 模式: '["start", "--", "--stdio"]' 运行 'npm start -- --stdio' 启动 Stdio 模式服务器。 '--' 用于分隔 npm 命令和传递给应用的参数。

基本使用方法

启动服务器:
- SSE 传输模式: 运行 'npm start' 命令启动服务器，默认使用 SSE 传输模式，监听 'MCP_PORT' 环境变量指定的端口 (默认为 8201)。
- Standard I/O 传输模式: 运行 'npm start -- --stdio' 命令启动服务器，使用 Standard I/O 传输模式。
客户端连接: 配置 MCP 客户端，根据选择的传输模式和上述服务器配置信息连接到 Mattermost MCP 服务器。
调用工具和 Prompt: 客户端连接成功后，可以调用已注册的 'mattermost' 工具 (Tool) 和 'mattermost' Prompt 模板 (Prompt) 来获取 Mattermost 消息数据，具体参数请参考工具和 Prompt 的定义。

关键词