> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Mural

> Mural is a digital whiteboard platform enabling distributed teams to visually brainstorm, map ideas, and collaborate in real time with sticky notes and diagrams

Mural is a digital whiteboard platform enabling distributed teams to visually brainstorm, map ideas, and collaborate in real time with sticky notes and diagrams

`mural` · **22 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth mural
run auth mural --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run mural          # common commands
run mural --all    # every command
```

```ts theme={"theme":"github-dark"}
import { mural } from "@boxd/run";
```

## Common tools

| Tool                    | What it does                                                                                                                                                           |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authorization-request` | Tool to initiate the OAuth 2.0 authorization process. Use when you need to redirect a user to Mural to obtain an authorization code.                                   |
| `create-sticky-note`    | Create one or more sticky note widgets on a mural. Each sticky note must be a properly structured object with required x and y coordinates.                            |
| `get-current-user`      | Tool to retrieve information about the currently authenticated user.                                                                                                   |
| `get-files-for-mural`   | Tool to retrieve a list of file widgets in a mural. Use after confirming the mural ID when listing file attachments.                                                   |
| `get-widgets`           | Tool to retrieve all widgets within a specified mural. Widgets include sticky notes, text boxes, shapes, images, areas, arrows, icons, files, and comments.            |
| `get-room`              | Tool to retrieve information about a specific room by its ID.                                                                                                          |
| `get-workspace`         | Tool to retrieve information about a specific workspace by its ID.                                                                                                     |
| `get-workspaces`        | Tool to retrieve all workspaces the authenticated user is a member of.                                                                                                 |
| `list-folders`          | Tool to list all folders within a room that the authenticated user has access to.                                                                                      |
| `list-recent-murals`    | Tool to list recently opened active murals for the authenticated user in a workspace.                                                                                  |
| `list-room-murals`      | Tool to list all murals for a room that the authenticated user has read access to.                                                                                     |
| `list-rooms`            | Tool to list all rooms within a workspace. Use after MURAL\_LIST\_WORKSPACES to navigate rooms and before MURAL\_CREATE\_MURAL, since murals are created within rooms. |
| `list-tags`             | Tool to retrieve all tags in a mural. Use when you need to list or view tags associated with a specific mural.                                                         |
| `list-templates`        | Tool to retrieve all default templates available in Mural. Use when you need to browse or select from standard Mural templates.                                        |
| `list-workspace-murals` | Tool to list all murals in a workspace that the authenticated user owns or is a member of.                                                                             |
| `search-murals`         | Tool to search for murals within a workspace. Returns all murals that the authenticated user owns or is a member of for the specified workspace.                       |
| `search-rooms`          | Tool to search for rooms within a workspace by name or description.                                                                                                    |
| `search-templates`      | Tool to search templates within a workspace that the authenticated user owns or has access to.                                                                         |

<Accordion title="All 22 tools" icon="list">
  | Tool                       | What it does                                                                                                                                                           |
  | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `authorization-request`    | Tool to initiate the OAuth 2.0 authorization process. Use when you need to redirect a user to Mural to obtain an authorization code.                                   |
  | `create-sticky-note`       | Create one or more sticky note widgets on a mural. Each sticky note must be a properly structured object with required x and y coordinates.                            |
  | `get-current-user`         | Tool to retrieve information about the currently authenticated user.                                                                                                   |
  | `get-files-for-mural`      | Tool to retrieve a list of file widgets in a mural. Use after confirming the mural ID when listing file attachments.                                                   |
  | `get-widgets`              | Tool to retrieve all widgets within a specified mural. Widgets include sticky notes, text boxes, shapes, images, areas, arrows, icons, files, and comments.            |
  | `get-room`                 | Tool to retrieve information about a specific room by its ID.                                                                                                          |
  | `get-workspace`            | Tool to retrieve information about a specific workspace by its ID.                                                                                                     |
  | `get-workspaces`           | Tool to retrieve all workspaces the authenticated user is a member of.                                                                                                 |
  | `list-folders`             | Tool to list all folders within a room that the authenticated user has access to.                                                                                      |
  | `list-open-rooms`          | Tool to list all discoverable open rooms within a workspace.                                                                                                           |
  | `list-recent-murals`       | Tool to list recently opened active murals for the authenticated user in a workspace.                                                                                  |
  | `list-recent-templates`    | Tool to retrieve recent templates used by a user for a workspace.                                                                                                      |
  | `list-room-murals`         | Tool to list all murals for a room that the authenticated user has read access to.                                                                                     |
  | `list-rooms`               | Tool to list all rooms within a workspace. Use after MURAL\_LIST\_WORKSPACES to navigate rooms and before MURAL\_CREATE\_MURAL, since murals are created within rooms. |
  | `list-room-users`          | Tool to list all members and guests for a room. Returns users that the authenticated user has access to view.                                                          |
  | `list-tags`                | Tool to retrieve all tags in a mural. Use when you need to list or view tags associated with a specific mural.                                                         |
  | `list-templates`           | Tool to retrieve all default templates available in Mural. Use when you need to browse or select from standard Mural templates.                                        |
  | `list-workspace-murals`    | Tool to list all murals in a workspace that the authenticated user owns or is a member of.                                                                             |
  | `list-workspace-templates` | Tool to get default and custom templates for a workspace. Use when you need to list available templates after authentication.                                          |
  | `search-murals`            | Tool to search for murals within a workspace. Returns all murals that the authenticated user owns or is a member of for the specified workspace.                       |
  | `search-rooms`             | Tool to search for rooms within a workspace by name or description.                                                                                                    |
  | `search-templates`         | Tool to search templates within a workspace that the authenticated user owns or has access to.                                                                         |
</Accordion>

[Open Mural in the console →](https://app.boxd.sh/integrations/detail/mural)
