Mattermost MCP

🚀 Mattermost Bot Controller Protocol (MCP) Server

The Mattermost Bot Controller Protocol (MCP) Server is a tool designed to manage and control Mattermost bots. It simplifies the process of setting up, configuring, and running bots on the Mattermost platform.

🚀 Quick Start

Installation and Configuration

Installation Steps

1. Download the code repository

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

2. Install dependencies

   npm install
   

3. Build the project

   npm run build
   

Configuration Instructions

Create a config.json file with the following content:

{
  "mattermostUrl": "https://your-mattermost-instance.com",
  "teamId": "your-team-id",
  "port": 3456,
  "webRoot": "/path/to/webroot"
}

💻 Usage Examples

Start the Server

Run the following command in the project root directory:

node build/index.js

Configuration Examples

Example 1: Basic Configuration

Add the following content to config.json:

{
  "mattermostUrl": "https://my-mattermost-server.com",
  "teamId": "T1234567890"
}

Example 2: Complete Configuration

{
  "mattermostUrl": "https://my-mattermost-server.com",
  "teamId": "T1234567890",
  "port": 3456,
  "webRoot": "/var/www/mattermost-web"
}

Using Claude Desktop

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "mattermost": {
      "command": "node",
      "args": [
        "/path/to/mattermost-mcp/build/index.js"
      ]
    }
  }
}

🛠️ Troubleshooting

Common Issues

1. Permission Errors:
   • Confirm that the personal access token has the correct permissions.
   • Ensure that the token is correctly configured in config.json.
   • Verify the accuracy of the Mattermost URL and team ID.
2. Network Issues:
   • Check the network connection to ensure access to the Mattermost server.
   • View console error messages in the browser developer tools.

🌐 HTTP Endpoints

Execute Monitoring

Trigger the monitoring process via the following URL:

curl http://localhost:3456/run-monitoring

Query Status

Get server and monitoring status information:

curl http://localhost:3456/status

🛠️ Tool Scripts

run-monitoring-http.sh

Use this script to trigger monitoring via the HTTP endpoint:

./run-monitoring-http.sh

Features:

• Does not restart the server.
• Does not conflict with scheduled tasks.
• Can be run from any terminal.

View Channel Messages

Display the latest messages in a specified channel:

node view-channel-messages.js <channel-name>
node view-channel-messages.js <channel-name> <message-count>

Example:

node view-channel-messages.js general 10

Analyze Channel Messages

Provide detailed statistical information about channel messages:

node analyze-channel.js <channel-name>
node analyze-channel.js <channel-name> <message-count>

Example:

node analyze-channel.js announcements

Get Help

Display available commands and usage instructions:

node utils/help.js

📄 License

This project is licensed under the MIT License.