Can I use Mattermost as a CLI?

Yes. KosmoKrator exposes a Mattermost CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Mattermost through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Mattermost tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Mattermost credentials stored?

Mattermost credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Mattermost MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

communication

Mattermost Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Mattermost KosmoKrator integration.

7 functions 6 read 1 write Bearer token auth

Submit Mattermost feedback View package source

Lua Namespace

Agents call this integration through app.integrations.mattermost.*. Use lua_read_doc("integrations.mattermost") inside KosmoKrator to discover the same reference at runtime.

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Mattermost — Lua API Reference

list_channels

List channels the current user belongs to.

Parameters

Name	Type	Required	Description
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of channels per page. Default: 60.

Response

Returns an array of channel objects:

Field	Type	Description
`id`	string	Channel ID
`name`	string	Channel URL name
`display_name`	string	Human-readable name
`type`	string	Channel type: `O` (public), `P` (private), `D` (direct)
`team_id`	string	Team this channel belongs to
`header`	string	Channel header text
`purpose`	string	Channel purpose text

Example

local channels = app.integrations.mattermost.list_channels({
  page = 0,
  per_page = 20
})

for _, ch in ipairs(channels) do
  print(ch.display_name .. " (" .. ch.type .. ") - " .. ch.id)
end

get_channel

Get details of a specific channel by ID.

Parameters

Name	Type	Required	Description
`channel_id`	string	yes	The channel ID.

Example

local channel = app.integrations.mattermost.get_channel({
  channel_id = "abc123def456"
})

print(channel.display_name .. ": " .. (channel.purpose or "No purpose set"))

create_post

Post a message to a channel.

Parameters

Name	Type	Required	Description
`channel_id`	string	yes	The channel to post the message in.
`message`	string	yes	The message text. Supports Markdown.

Response

Returns the created post object with id, create_at, update_at, and the message content.

Example

local post = app.integrations.mattermost.create_post({
  channel_id = "abc123def456",
  message = "Hello from the AI agent! :robot:"
})

print("Posted message ID: " .. post.id)

list_posts

List posts in a channel.

Parameters

Name	Type	Required	Description
`channel_id`	string	yes	The channel ID.
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of posts per page. Default: 60.

Response

Returns an object with order (array of post IDs) and posts (map of post ID → post object). Each post has:

Field	Type	Description
`id`	string	Post ID
`message`	string	Post content
`user_id`	string	Author user ID
`channel_id`	string	Channel ID
`create_at`	integer	Creation timestamp (ms)
`update_at`	integer	Last update timestamp (ms)

Example

local result = app.integrations.mattermost.list_posts({
  channel_id = "abc123def456",
  page = 0,
  per_page = 10
})

for _, postId in ipairs(result.order) do
  local post = result.posts[postId]
  print(post.user_id .. ": " .. post.message)
end

get_post

Get a specific post by ID.

Parameters

Name	Type	Required	Description
`post_id`	string	yes	The post ID.

Example

local post = app.integrations.mattermost.get_post({
  post_id = "xyz789"
})

print("Message: " .. post.message)
print("Author: " .. post.user_id)

list_teams

List teams the current user belongs to.

Parameters

Name	Type	Required	Description
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of teams per page. Default: 60.

Response

Returns an array of team objects:

Field	Type	Description
`id`	string	Team ID
`name`	string	Team URL name
`display_name`	string	Human-readable team name
`description`	string	Team description
`type`	string	Team type: `O` (open), `I` (invite)
`email`	string	Team email

Example

local teams = app.integrations.mattermost.list_teams({})

for _, team in ipairs(teams) do
  print(team.display_name .. " (" .. team.type .. ")")
end

get_current_user

Get the profile of the currently authenticated user.

Parameters

None.

Response

Returns a user object:

Field	Type	Description
`id`	string	User ID
`username`	string	Username
`email`	string	Email address
`nickname`	string	Display nickname
`first_name`	string	First name
`last_name`	string	Last name
`roles`	string	User roles (e.g., “system_admin”)
`locale`	string	User locale (e.g., “en”)

Example

local user = app.integrations.mattermost.get_current_user({})

print("Logged in as: @" .. user.username .. " (" .. user.email .. ")")

Multi-Account Usage

If you have multiple Mattermost accounts configured, use account-specific namespaces:

-- Default account (always works)
app.integrations.mattermost.function_name({...})

-- Explicit default (portable across setups)
app.integrations.mattermost.default.function_name({...})

-- Named accounts
app.integrations.mattermost.work.function_name({...})
app.integrations.mattermost.staging.function_name({...})

All functions are identical across accounts — only the credentials differ.

Raw agent markdown

# Mattermost — Lua API Reference

## list_channels

List channels the current user belongs to.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `page` | integer | no | Page number (0-indexed). Default: 0. |
| `per_page` | integer | no | Number of channels per page. Default: 60. |

### Response

Returns an array of channel objects:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Channel ID |
| `name` | string | Channel URL name |
| `display_name` | string | Human-readable name |
| `type` | string | Channel type: `O` (public), `P` (private), `D` (direct) |
| `team_id` | string | Team this channel belongs to |
| `header` | string | Channel header text |
| `purpose` | string | Channel purpose text |

### Example

```lua
local channels = app.integrations.mattermost.list_channels({
  page = 0,
  per_page = 20
})

for _, ch in ipairs(channels) do
  print(ch.display_name .. " (" .. ch.type .. ") - " .. ch.id)
end
```

---

## get_channel

Get details of a specific channel by ID.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `channel_id` | string | yes | The channel ID. |

### Example

```lua
local channel = app.integrations.mattermost.get_channel({
  channel_id = "abc123def456"
})

print(channel.display_name .. ": " .. (channel.purpose or "No purpose set"))
```

---

## create_post

Post a message to a channel.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `channel_id` | string | yes | The channel to post the message in. |
| `message` | string | yes | The message text. Supports Markdown. |

### Response

Returns the created post object with `id`, `create_at`, `update_at`, and the message content.

### Example

```lua
local post = app.integrations.mattermost.create_post({
  channel_id = "abc123def456",
  message = "Hello from the AI agent! :robot:"
})

print("Posted message ID: " .. post.id)
```

---

## list_posts

List posts in a channel.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `channel_id` | string | yes | The channel ID. |
| `page` | integer | no | Page number (0-indexed). Default: 0. |
| `per_page` | integer | no | Number of posts per page. Default: 60. |

### Response

Returns an object with `order` (array of post IDs) and `posts` (map of post ID → post object). Each post has:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Post ID |
| `message` | string | Post content |
| `user_id` | string | Author user ID |
| `channel_id` | string | Channel ID |
| `create_at` | integer | Creation timestamp (ms) |
| `update_at` | integer | Last update timestamp (ms) |

### Example

```lua
local result = app.integrations.mattermost.list_posts({
  channel_id = "abc123def456",
  page = 0,
  per_page = 10
})

for _, postId in ipairs(result.order) do
  local post = result.posts[postId]
  print(post.user_id .. ": " .. post.message)
end
```

---

## get_post

Get a specific post by ID.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `post_id` | string | yes | The post ID. |

### Example

```lua
local post = app.integrations.mattermost.get_post({
  post_id = "xyz789"
})

print("Message: " .. post.message)
print("Author: " .. post.user_id)
```

---

## list_teams

List teams the current user belongs to.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `page` | integer | no | Page number (0-indexed). Default: 0. |
| `per_page` | integer | no | Number of teams per page. Default: 60. |

### Response

Returns an array of team objects:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Team ID |
| `name` | string | Team URL name |
| `display_name` | string | Human-readable team name |
| `description` | string | Team description |
| `type` | string | Team type: `O` (open), `I` (invite) |
| `email` | string | Team email |

### Example

```lua
local teams = app.integrations.mattermost.list_teams({})

for _, team in ipairs(teams) do
  print(team.display_name .. " (" .. team.type .. ")")
end
```

---

## get_current_user

Get the profile of the currently authenticated user.

### Parameters

None.

### Response

Returns a user object:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | User ID |
| `username` | string | Username |
| `email` | string | Email address |
| `nickname` | string | Display nickname |
| `first_name` | string | First name |
| `last_name` | string | Last name |
| `roles` | string | User roles (e.g., "system_admin") |
| `locale` | string | User locale (e.g., "en") |

### Example

```lua
local user = app.integrations.mattermost.get_current_user({})

print("Logged in as: @" .. user.username .. " (" .. user.email .. ")")
```

---

## Multi-Account Usage

If you have multiple Mattermost accounts configured, use account-specific namespaces:

```lua
-- Default account (always works)
app.integrations.mattermost.function_name({...})

-- Explicit default (portable across setups)
app.integrations.mattermost.default.function_name({...})

-- Named accounts
app.integrations.mattermost.work.function_name({...})
app.integrations.mattermost.staging.function_name({...})
```

All functions are identical across accounts — only the credentials differ.

Metadata-Derived Lua Example

local result = app.integrations.mattermost.mattermost_list_channels({
  page = 1,
  per_page = 1
})
print(result)

Functions

`mattermost_list_channels`

List channels the current user belongs to in Mattermost. Returns channel IDs, names, types, and team associations. Use this to discover available channels before posting messages or reading posts.

Operation: Read read
Full name: mattermost.mattermost_list_channels

Parameter	Type	Required	Description
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of channels per page. Default: 60.

`mattermost_get_channel`

Get details of a specific Mattermost channel by ID. Returns channel name, display name, type, header, purpose, and member counts.

Operation: Read read
Full name: mattermost.mattermost_get_channel

Parameter	Type	Required	Description
`channel_id`	string	yes	The channel ID.

`mattermost_create_post`

Post a message to a Mattermost channel. Provide the channel_id and the message text. Returns the created post with its ID and timestamp.

Operation: Write write
Full name: mattermost.mattermost_create_post

Parameter	Type	Required	Description
`channel_id`	string	yes	The channel ID to post the message in.
`message`	string	yes	The message text to post. Supports Markdown formatting.

`mattermost_list_posts`

List posts in a Mattermost channel. Returns post IDs, messages, author info, and timestamps. Use page and per_page for pagination.

Operation: Read read
Full name: mattermost.mattermost_list_posts

Parameter	Type	Required	Description
`channel_id`	string	yes	The channel ID to list posts from.
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of posts per page. Default: 60.

`mattermost_get_post`

Get a specific Mattermost post by ID. Returns the full post including message content, author, channel, and timestamps.

Operation: Read read
Full name: mattermost.mattermost_get_post

Parameter	Type	Required	Description
`post_id`	string	yes	The post ID.

`mattermost_list_teams`

List teams the current user belongs to in Mattermost. Returns team IDs, names, display names, and types. Use this to discover available teams before working with channels.

Operation: Read read
Full name: mattermost.mattermost_list_teams

Parameter	Type	Required	Description
`page`	integer	no	Page number (0-indexed). Default: 0.
`per_page`	integer	no	Number of teams per page. Default: 60.

`mattermost_get_current_user`

Get the profile of the currently authenticated Mattermost user. Returns username, email, display name, roles, and locale.

Operation: Read read
Full name: mattermost.mattermost_get_current_user

Parameter	Type	Required	Description
No parameters.