Mattermost MCP Server

🚀 Mattermost MCP Server

This project implements a Model Context Protocol (MCP) server integrated with Mattermost. It connects to the Mattermost API endpoints to fetch and process various information, and provides this information through the standard MCP transmission.

🚀 Quick Start

The Mattermost MCP Server connects to Mattermost API endpoints to manage and transmit data. You can follow the installation steps below to set up the server and start using it.

✨ Features

• Connect to Mattermost API endpoints.
• Support multiple transmission modes:
  • SSE (Server-Sent Events)
  • Standard I/O
• Real-time message processing.
• Team and channel-specific monitoring.
• Token-based security authentication.

📦 Installation

Prerequisites

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

Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Set up environment variables:

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

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

Required environment variables:

• MCP_PORT: Port number for SSE transmission mode (default: 8201).
• MATTERMOST_ENDPOINT: Your Mattermost server URL.
• MATTERMOST_TOKEN: Your Mattermost authentication token.
• MATTERMOST_TEAM_ID: Team ID to monitor.
• MATTERMOST_CHANNELS: Comma-separated list of channel names for monitoring.

4. Build the server:

npm run build

💻 Usage Examples

Basic Usage

The server can run in two transmission modes:

SSE Transmission Mode

npm start

Standard I/O Transmission Mode

npm start -- --stdio

Advanced Usage

Here are some commands for development:

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

📚 Documentation

References

• Model Context Protocol TypeScript SDK
• MCP Inspector Tool

📄 License

This project is licensed under the MIT license.