mattermost-mcp
A Model Context Protocol server for Mattermost. It lets an AI agent (Claude, Cursor, VS Code, any MCP client) catch up on your unreads and mentions, read channels, threads and DMs, and search. If you switch write mode on, the agent can also post, reply, send DMs, edit its own messages and react.
- Read-only by default. Write tools are not even registered until you set
MATTERMOST_ENABLE_WRITE=1. Even then, the agent can only edit posts written by your own account. - Sees what you see. Unread counts match the client badge (muted channels are skipped, collapsed-thread counts are used) and sidebar categories work as filters. Mentions from muted channels are still shown.
- Works where personal access tokens don't. Use a personal access token
(PAT) or bot token if you can. If an admin has disabled PATs, or a proxy
strips the
Authorizationheader, use your browser session cookies instead. - Fast. Channel metadata is fetched once, across teams in parallel, and cached briefly. No per-channel requests.
Quick start
- Create a personal access token in Mattermost: Profile → Security → Personal Access Tokens → Create Token. If that section is missing, an admin must enable System Console → Integrations → Integration Management → Enable Personal Access Tokens (or see Cookie auth).
- Install uv.
- Add the server to your client.
Claude Code
claude mcp add mattermost \
-e MATTERMOST_URL=https://mattermost.example.com \
-e MATTERMOST_ACCESS_TOKEN=your-token \
-- uvx mattermost-mcp-server
Claude Desktop (claude_desktop_config.json), Cursor
(~/.cursor/mcp.json) and other clients that use mcpServers:
{
"mcpServers": {
"mattermost": {
"command": "uvx",
"args": ["mattermost-mcp-server"],
"env": {
"MATTERMOST_URL": "https://mattermost.example.com",
"MATTERMOST_ACCESS_TOKEN": "your-token"
}
}
}
}
VS Code (.vscode/mcp.json):
{
"inputs": [
{ "type": "promptString", "id": "mm-token", "description": "Mattermost access token", "password": true }
],
"servers": {
"mattermost": {
"command": "uvx",
"args": ["mattermost-mcp-server"],
"env": {
"MATTERMOST_URL": "https://mattermost.example.com",
"MATTERMOST_ACCESS_TOKEN": "${input:mm-token}"
}
}
}
}
Then try asking: "What did I miss in Mattermost today?" or "Summarize the thread about the release in #engineering."
To let the agent post, add "MATTERMOST_ENABLE_WRITE": "1" to env (see
Write mode).
Tools
| Tool | Kind | What it does |
|---|---|---|
get_unread |
read | Unread and mention counts per channel; skips muted channels by default, like the client badge |
get_mentions |
read | Posts that mention you, newest first; since, limit |
list_channels |
read | Your channels with unread_count, mute state and sidebar category; filter by team, category, DMs, muted |
get_channel_posts |
read | Recent posts in a channel; since (ISO 8601) or before (post ID) to page back |
get_thread |
read | A root post and all its replies |
search_posts |
read | Full-text search with Mattermost syntax (from:, in:, after:…), optionally scoped to one channel or a sidebar category; skips muted channels by default |
get_direct_messages |
read | DM history with a user; since, before |
get_user |
read | A user's profile by username |
search_users |
read | Find users by name, username or email prefix |
get_me |
read | Your profile, the auth mode, and whether write mode is on |
list_teams |
read | Your teams |
get_post |
read | One post by ID |
get_channel |
read | A channel by ID or by name (town-square), with header and purpose |
get_pinned_posts |
read | Pinned posts of a channel |
get_file_info |
read | Name, type and size of an attached file (content is not downloaded) |
create_post |
write | Post in a channel, or reply in a thread with root_id |
send_direct_message |
write | DM a user by username |
update_post |
write | Edit one of your own posts; refuses anyone else's |
add_reaction |
write | React with an emoji (thumbsup or :thumbsup:) |
remove_reaction |
write | Remove your reaction; no error if it was not there |
Every tool carries MCP annotations (readOnlyHint, destructiveHint,
idempotentHint), so clients can auto-approve reads and ask before writes.
Nothing can delete posts, change channels or perform admin actions.
Write mode
Write mode is off unless MATTERMOST_ENABLE_WRITE is 1, true, yes or
on. When it is off:
- the five write tools are not registered, so the model never sees them;
- the HTTP client refuses every request that is not a GET or one of the read-only POSTs (user lookup, user search, post search), before anything is sent.
The one server-side effect of read-only mode is the same as in any
Mattermost client: get_direct_messages with someone you have never
messaged creates the (empty) DM channel between you.
When write mode is on, update_post checks the post's author and refuses
any post that is not yours, even if your account has permission to edit
other people's posts. Posts are written as the authenticated user (or bot),
so consider a dedicated bot account for agents that post on their own.
Configuration
| Variable | Default | Meaning |
|---|---|---|
MATTERMOST_URL |
— (required) | Base URL of your server, e.g. https://mattermost.example.com |
MATTERMOST_ACCESS_TOKEN |
— | Personal access token or bot token; selects token auth |
MATTERMOST_ENABLE_WRITE |
off | 1 enables the write tools |
MATTERMOST_AUTH_MODE |
auto | token or cookie, to force a mode (see below) |
MATTERMOST_TOKEN |
— | Cookie auth: value of the MMAUTHTOKEN cookie |
MATTERMOST_CSRF |
— | Cookie auth: value of the MMCSRF cookie; required for write tools |
MATTERMOST_USER_ID |
— | Cookie auth: value of the MMUSERID cookie (optional) |
MATTERMOST_CACHE_TTL |
60 |
Seconds to cache channel metadata; 0 disables the cache |
MATTERMOST_TRUST_ENV |
1 |
0 ignores HTTP(S)_PROXY/ALL_PROXY and connects to Mattermost directly |
MATTERMOST_AUTH_HELP |
— | Extra text appended to the 401 error, e.g. how credentials are rotated in your setup |
MATTERMOST_KEYCHAIN_SERVICE |
mattermost-mcp |
Keychain service name (see Credential sources) |
MATTERMOST_COOKIE_HOST |
off | Cookie host: ssh alias, or local |
MATTERMOST_COOKIE_PATH |
.config/mattermost-mcp/cookie.env |
Cookie host: file path, relative to $HOME on the host |
MATTERMOST_COOKIE_CACHE |
~/.cache/mattermost-mcp/cookie.cache |
Cookie host: local cache file (mode 0600) |
MATTERMOST_COOKIE_TTL |
900 |
Cookie host: cache lifetime, seconds |
MATTERMOST_COOKIE_SSH_TIMEOUT |
10 |
Cookie host: ssh connect timeout, seconds |
Choosing the auth mode. If MATTERMOST_AUTH_MODE is unset, the first
credential source that has any credential decides. The sources are checked
in order: env, then cookie host, then keychain. MATTERMOST_ACCESS_TOKEN in
that source means token mode. MATTERMOST_TOKEN alone means cookie mode. A
lower-priority source never overrides a higher one.
Cookie auth
Use this when personal access tokens are disabled on your server, or when a
reverse proxy strips the Authorization header.
- Log in to Mattermost in a browser and open DevTools → Application → Cookies.
- Copy
MMAUTHTOKEN,MMCSRFand (optionally)MMUSERIDintoMATTERMOST_TOKEN,MATTERMOST_CSRFandMATTERMOST_USER_ID.
Session cookies expire. When they do, tool calls fail with a 401 error. Put
fresh cookies wherever the server reads them from, then restart it, because
env is read only once. If something rotates cookies for you, describe it in
MATTERMOST_AUTH_HELP so the agent knows what to do.
Credential sources
The server resolves each field separately. The first source that has a value wins:
-
Environment variables, as above.
-
Cookie host (off by default). A plain
KEY=VALUEfile with the same variable names, kept on another machine and read over ssh. Use this when one machine rotates the credential and others just consume it. The result is cached locally. On a 401 the server pulls the file again and retries once. ssh runs withBatchMode=yes, so a locked key fails fast instead of hanging the MCP handshake, and the reason goes to stderr. The file may only supplyMATTERMOST_URL,MATTERMOST_ACCESS_TOKEN,MATTERMOST_TOKEN,MATTERMOST_CSRFandMATTERMOST_USER_ID. Nothing else is read from it, not even the auth or write mode. -
OS keychain: accounts
url,access_token,token,csrfanduser_idunder the serviceMATTERMOST_KEYCHAIN_SERVICE.# macOS security add-generic-password -s mattermost-mcp -a url -w https://mattermost.example.com security add-generic-password -s mattermost-mcp -a access_token -w <personal access token> # Linux (pass) pass insert mattermost-mcp/url pass insert mattermost-mcp/access_token
Troubleshooting
Mattermost rejected the access token (401): the token was revoked or mistyped. Create a new one, or check whether your account is still allowed to use personal access tokens.Mattermost rejected the session cookies (401): the browser session expired. Copy fresh cookies and restart the server.Write tools in cookie mode need the MMCSRF cookie: setMATTERMOST_CSRF. Mattermost requires it for any change made with cookie auth.write mode is disabled: setMATTERMOST_ENABLE_WRITE=1and restart the client.- Requests time out behind a corporate proxy: the server honours
HTTPS_PROXY/ALL_PROXY, including SOCKS. If that proxy should not be used for Mattermost, setMATTERMOST_TRUST_ENV=0. - Nothing happens in Claude Desktop: GUI apps do not inherit your shell
PATH. Use the full path touvx(which uvx) ascommand.
Development
git clone https://github.com/toffguy77/mattermost-mcp.git
cd mattermost-mcp
uv sync
uv run pytest
uv run ruff check
Run your local checkout from a client with
uv run --project /path/to/mattermost-mcp mattermost-mcp.
python -m mattermost_mcp works too. The tests never touch the network or
ssh: HTTP is mocked with respx. See CONTRIBUTING.md,
CHANGELOG.md and SECURITY.md.
License
MIT
Metadata
Release files for mattermost-mcp-server 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mattermost_mcp_server-1.0.0.tar.gz | 146.0 kB | With provenance | Details for mattermost_mcp_server-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mattermost_mcp_server-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for mattermost_mcp_server-1.0.0-py3-none-any.whl |
Total release size: 170.9 kB
Release files / mattermost_mcp_server-1.0.0.tar.gz
| Download URL | mattermost_mcp_server-1.0.0.tar.gz |
|---|---|
| Size | 146.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1311893f6c95b37dbf9c934b1ed5c540770d7b8b32bb4bb68d94552c61c42681
|
|
BLAKE2b-256 checksum How to use checksums |
4dcdf0b0e61c6b9efc5ce667368971bd8ba0173a607ba422d022566d57d5446e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.
Transparency logRelease files / mattermost_mcp_server-1.0.0-py3-none-any.whl
| Download URL | mattermost_mcp_server-1.0.0-py3-none-any.whl |
|---|---|
| Size | 24.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
279951c5b11a0de74feeed68e159f43e197a7e09ddefe5f9f0ae5063eb2c74a1
|
|
BLAKE2b-256 checksum How to use checksums |
dcc9b356bc8fa75c3e2271afae1b5289f6051036306ac75c914591a754a593d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.
Transparency logSecurity for mattermost-mcp-server 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for mattermost_mcp_server-1.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.