mcp-server-mattermost

该项目实现了一个用于Mattermost集成的模型上下文协议（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）

# 安装dotenvx（可选）
npm install -g @dotenvx/dotenvx

# 创建.env文件
cp .env.example .env
# 使用你的值编辑.env文件

# 加密你的.env文件（建议在生产环境中使用）
dotenvx encrypt

4. 构建服务器：

npm run build

使用方法

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

标准I/O传输模式

# 使用npm脚本（与dotenvx）
npm run start:stdio

# 直接执行
node dist/main.js --transport stdio

# 使用npx
npx mcp-server-mattermost --transport stdio

SSE传输模式

# 使用npm脚本（与dotenvx）
npm run start:sse

# 直接执行
node dist/main.js --transport sse

HTTP传输模式

# 使用npm脚本（与dotenvx）
npm run start:http

# 直接执行
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检查器

参考资料

• 模型上下文协议TypeScript SDK
• MCP检查器

许可证

MIT