What is Mcp Server Mattermost

mcp-server-mattermost is a Model Context Protocol (MCP) server designed for integration with Mattermost. It connects to Mattermost API endpoints to retrieve and process various information, making it accessible through standard MCP transports.

Use cases

Use cases for mcp-server-mattermost include monitoring specific teams and channels in Mattermost, processing real-time messages for notifications, and integrating Mattermost with other applications using the Model Context Protocol.

How to use

To use mcp-server-mattermost, clone the repository, install the dependencies, set up your environment variables, and build the server. You can then run the server in either SSE transport mode or Standard I/O transport mode.

Key features

Key features include connection to Mattermost API endpoints, support for multiple transport modes (SSE and Standard I/O), real-time message processing, team and channel-specific monitoring, and secure token-based authentication.

Where to use

mcp-server-mattermost can be used in environments that require real-time communication and monitoring within Mattermost, such as team collaboration tools, customer support systems, and project management applications.

mcp-server-mattermost

This project implements a Model Context Protocol (MCP) server for Mattermost integration. It connects to Mattermost API endpoints to retrieve and process various information, making it available through standard MCP transports.

Features

• Secure, token-based connection to Mattermost API endpoints
• Supports multiple transport modes:
  • stdio
  • http-stream
  • sse
• Search for messages across multiple Mattermost channels
• Customizable default channels and message fetch limits

Requirements

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

Setup

1. Clone this repository:

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

2. Install dependencies:

npm install

3. Set up your environment variables:

# Create .env file
cp .env.example .env

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

Required environment variables:

• MATTERMOST_ENDPOINT: Your Mattermost server URL
• MATTERMOST_TOKEN: Your Mattermost authentication token
• MATTERMOST_TEAM_ID: The ID of the team to monitor
• MATTERMOST_CHANNELS: Comma-separated list of channel names to monitor

4. Build the server:

npm run build

Usage

The server supports three transport modes: stdio (default), sse, and http-stream.

Standard I/O Transport Mode

npm run start:stdio
# or
npx dotenvx run -q -- "node dist/main.js --transport stdio"

SSE Transport Mode

npm run start:sse
# or
npx dotenvx run -q -- "node dist/main.js --transport sse"

HTTP Transport Mode

npm run start:http
# or
npx dotenvx run -q -- "node dist/main.js --transport http-stream"

Development

• npm run dev: Start the server in development mode with hot reload
• npm run lint: Run ESLint
• npm run format: Format code using Prettier
• npm test: Run tests
• npm run inspect: Run MCP inspector

References

• Model Context Protocol TypeScript SDK
• MCP inspector

License

MIT