@atyaga/mcp-mattermost
v0.0.9
Published
MCP (Model Context Protocol) server for Mattermost
Readme
MCP Mattermost Server
This is an MCP (Model Context Protocol) server for Mattermost, written in TypeScript. It provides various tools for interacting with the Mattermost API.
Installation
To run this tool, you need to set the following environment variables:
{
...
"mcp-mattermost": {
"command": "npx",
"args": [
"@dakatan/mcp-mattermost"
],
"env": {
"MCP_MATTERMOST_URL": "https://mattermost.x.y",
"MCP_MATTERMOST_TOKEN": "<personal access token or bot token>",
"MCP_MATTERMOST_TEAM_ID": "",
"MCP_MATTERMOST_TEAM_NAME": ""
}
},
...
}Configuration
| Variable Name | Description | Required |
| -------------------------- | ----------------------------------------------------------------------------------- | -------- |
| MCP_MATTERMOST_URL | The URL of your Mattermost instance | Yes |
| MCP_MATTERMOST_TOKEN | Your Mattermost personal access token or bot token | Yes |
| MCP_MATTERMOST_TEAM_ID | Team ID(s) — single value or comma-separated list (e.g. id1,id2) | No |
| MCP_MATTERMOST_TEAM_NAME | Team name(s) — single value or comma-separated list (e.g. team-a,team-b) | No |
Team configuration
- Single team: provide a single
MCP_MATTERMOST_TEAM_IDorMCP_MATTERMOST_TEAM_NAME - Multiple teams: provide a comma-separated list, e.g.
MCP_MATTERMOST_TEAM_ID=id1,id2,id3 - Auto-discover: if neither variable is set, the server will automatically discover all teams the user/bot belongs to via the
getMyTeams()API
Both MCP_MATTERMOST_TEAM_ID and MCP_MATTERMOST_TEAM_NAME can be set simultaneously — teams from both will be combined.
Note: Using MCP_MATTERMOST_TEAM_ID is recommended as it's more reliable and efficient than using team names.
Bot token support
Bot tokens in Mattermost work identically to personal access tokens — both use Authorization: BEARER <token>. Simply set MCP_MATTERMOST_TOKEN to your bot token value.
HTTP Server (Remote Deployment)
The server can also run as an HTTP service using the Streamable HTTP transport, allowing remote clients (e.g. Cursor IDE) to connect via URL.
Running the HTTP server
node build/http-server.jsAdditional environment variable:
| Variable Name | Description | Default |
| ------------------ | ------------------------------------------------------------------------ | ------- |
| MCP_HTTP_PORT | HTTP server port | 3002 |
| MCP_LOG_LEVEL | Log level: debug, info, warn, error, silent | info |
| MCP_AUTH_TOKENS | Bearer token auth: comma-separated username:token pairs (see below) | — |
Authentication
Set MCP_AUTH_TOKENS to enable Bearer token authentication. Format: username:token pairs separated by commas.
MCP_AUTH_TOKENS=alice:abc123secret,bob:xyz789secretIf MCP_AUTH_TOKENS is not set or empty, authentication is disabled (all requests are allowed). The /health endpoint is always accessible without authentication.
Client configuration (Cursor IDE)
{
"mcpServers": {
"mcp-mattermost": {
"url": "https://your-server.example.com/mcp",
"headers": {
"Authorization": "Bearer abc123secret"
}
}
}
}Deployment with systemd and nginx
- Clone and build the project on your server:
cd /data/mcp-servers
git clone <repo-url> mcp-mattermost
cd mcp-mattermost
npm ci
npm run build- Create an environment file (e.g.
/data/mcp-servers/mcp-mattermost/.env):
MCP_MATTERMOST_URL=https://your-mattermost.example.com/
MCP_MATTERMOST_TOKEN=<token>
MCP_MATTERMOST_TEAM_ID=<team-id>
MCP_HTTP_PORT=3002
MCP_LOG_LEVEL=info
MCP_AUTH_TOKENS=alice:abc123secret,bob:xyz789secret- Create a systemd service (
/etc/systemd/system/mcp-mattermost.service):
[Unit]
Description=MCP Mattermost Server (Streamable HTTP)
After=network.target
[Service]
Type=simple
User=srvadmin
WorkingDirectory=/data/mcp-servers/mcp-mattermost
EnvironmentFile=/data/mcp-servers/mcp-mattermost/.env
ExecStart=/usr/bin/node build/http-server.js
Restart=on-failure
RestartSec=5
[Install]
WantedBy=multi-user.target- Enable and start the service:
sudo systemctl daemon-reload
sudo systemctl enable mcp-mattermost
sudo systemctl start mcp-mattermost- Add an nginx location block (with SSE-compatible proxy settings):
location /mcp {
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header Connection '';
proxy_http_version 1.1;
chunked_transfer_encoding off;
proxy_buffering off;
proxy_cache off;
proxy_pass http://127.0.0.1:3002;
}Tools Provided
The MCP server provides the following tools:
- User management:
mattermost_get_users,mattermost_search_users - Channel management:
mattermost_search_channels,mattermost_get_channels,mattermost_get_my_channels - Post management:
mattermost_search_posts,mattermost_get_posts,mattermost_get_channel_posts,mattermost_create_post,mattermost_get_posts_thread,mattermost_pin_post,mattermost_unpin_post,mattermost_get_pinned_posts - Reaction management:
mattermost_add_reaction,mattermost_remove_reaction,mattermost_get_reactions
