mattermost-mcp-server

mcp-server-mattermost

本项目实现了一个用于集成 Mattermost 的 Model Context Protocol（MCP）服务。它连接到 Mattermost API 端点，以检索和处理各种信息，并通过标准 MCP 传输方式提供这些信息。

功能

• 使用基于令牌的方式安全连接到 Mattermost API 端点
• 支持多种传输模式：
  • stdio
  • http-stream
  • sse
• 搜索多个 Mattermost 频道中的消息
• 可自定义默认频道和消息获取限制

要求

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

设置

1. 克隆此仓库：

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

2. 安装依赖：

npm install

3. 设置环境变量：

必需的环境变量

• MATTERMOST_ENDPOINT：Mattermost 服务 URL
• MATTERMOST_TOKEN：Mattermost 身份验证令牌
• MATTERMOST_TEAM：要监控的团队名称
• MATTERMOST_CHANNELS：要监控的频道名称，以逗号分隔

环境变量设置选项

选项 1：直接设置环境变量

export MATTERMOST_ENDPOINT="https://your-mattermost-server.com"
export MATTERMOST_TOKEN="your-token-here"
export MATTERMOST_TEAM="your-team-name"
export MATTERMOST_CHANNELS="general,random,dev"

选项 2：使用 .env 文件（搭配 dotenvx）

# Install dotenvx (optional)
npm install -g @dotenvx/dotenvx

# Create .env file
cp .env.example .env
# Edit .env file with your values

# Encrypt your .env file (recommended for production)
dotenvx encrypt

4. 构建服务：

npm run build

用法

服务支持三种传输模式：stdio（默认）、sse 和 http-stream。

标准 I/O 传输模式

# Using npm scripts (with dotenvx)
npm run start:stdio

# Direct execution
node dist/main.js --transport stdio

# Using npx
npx mcp-server-mattermost --transport stdio

SSE 传输模式

# Using npm scripts (with dotenvx)
npm run start:sse

# Direct execution
node dist/main.js --transport sse

HTTP 传输模式

# Using npm scripts (with dotenvx)
npm run start:http

# Direct execution
node dist/main.js --transport http-stream

Claude Desktop 集成

若要将此 MCP 服务与 Claude Desktop 搭配使用，请将以下配置添加到 Claude Desktop 设置中：

配置示例

{
  "mcpServers": {
    "mattermost": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-mattermost@latest",
        "--transport", "stdio",
        "--endpoint", "https://your-mattermost-server/api/v4",
        "--token", "your_personal_access_token",
        "--team", "your_team_name",
        "--channels", "town-square,general,your_channel_name"
      ]
    }
  }
}

开发

• npm run dev：以开发模式启动服务并启用热重载
• npm run lint：运行 ESLint
• npm run format：使用 Prettier 格式化代码
• npm test：运行测试
• npm run inspect：运行 MCP inspector

参考资料

• Model Context Protocol TypeScript SDK
• MCP inspector

许可证

MIT