npm package: @hagivu/openclaw-mattermost
Description: OpenClaw Mattermost channel plugin - enables your AI assistant to interact through Mattermost chat
Author: hagivu
Latest version: 1.0.4

# @hagivu/openclaw-mattermost

OpenClaw Mattermost channel plugin - enables your AI assistant to interact through Mattermost chat.

## Installation

```bash
# Install OpenClaw (if not already installed)
npm install -g openclaw

# Install Mattermost plugin
openclaw plugins install @hagivu/openclaw-mattermost

# Enable the plugin
openclaw plugins enable mattermost
```

## Requirements

- **Mattermost Server**: Self-hosted Mattermost instance (version 7.0+)
- **Bot Account**: Create a bot account in Mattermost
  - Go to **System Console → Integrations → Bot Accounts**
  - Click **Add Bot Account**
  - Copy the **Bot Token**
- **Base URL**: Your Mattermost server URL (e.g., `https://team.example.com`)

## Configuration

### Interactive Setup

```bash
openclaw configure
```

Select "Mattermost" channel and provide:
- **Bot Token**: Your Mattermost bot access token
- **Base URL**: Your Mattermost server URL (including https://)

### Manual Configuration

Edit `~/.openclaw/openclaw.json`:

```json
{
  "channels": {
    "mattermost": {
      "botToken": "your-bot-token-here",
      "baseUrl": "https://team.example.com"
    }
  }
}
```

## Usage

### Start the Gateway

```bash
# Install as system service (recommended)
openclaw gateway install --force
sudo systemctl start openclaw-gateway  # Linux
# or just run: openclaw gateway install --force (macOS)

# Or run in foreground
openclaw gateway
```

### Interact with the Bot

In Mattermost:
```
@yourbotname hello
@yourbotname what's the weather today?
@yourbotname help me write some code
```

## Features

- ✅ Direct messages and @mentions
- ✅ Channel conversations
- ✅ Thread support
- ✅ File attachments
- ✅ Real-time message streaming
- ✅ Group mentions (@channel, @all)
- ✅ Multi-account support

## Troubleshooting

### Plugin not loading

```bash
# Check plugin status
openclaw plugins list | grep mattermost

# Should show: mattermost (enabled)
```

### Connection errors

```bash
# Test Mattermost connection
curl https://your-mattermost-url/api/v4/system/ping

# Check gateway logs
sudo journalctl -u openclaw-gateway -f  # Linux
tail -f ~/.openclaw/logs/gateway.log    # macOS
```

### Bot not responding

1. Verify bot token is correct
2. Check bot has permissions in the channel
3. Ensure gateway is running: `openclaw gateway status`
4. Check OpenClaw logs for errors

## Development

### Build from source

```bash
git clone https://github.com/yourusername/openclaw.git
cd openclaw/extensions/mattermost
pnpm install
pnpm build
```

## License

MIT

## Links

- [OpenClaw Documentation](https://openclaw.ai/docs)
- [Mattermost API Docs](https://api.mattermost.com/)
- [npm Package](https://www.npmjs.com/package/@hagivu/openclaw-mattermost)
- [Report Issues](https://github.com/hagivu/openclaw/issues)

## Version History

### 1.0.1 (2026-02-07)
- ✅ Fixed: Added `openclaw.extensions` metadata for plugin system
- ✅ Added: Complete README documentation

### 1.0.0 (2026-02-07)
- 🎉 Initial release
- ✅ Basic Mattermost channel support
- ✅ Bot integration
- ✅ Message streaming