Skip to main content

Set up Miro

Connect Miro tools and board indexing in one setup flow. Use this guide when the Miro setup page shows Connect, Set up indexing, and Review setup.

The tools connection and indexing credentials are separate. The Connect step uses Miro's hosted Model Context Protocol (MCP) server and handles OAuth app registration for you. The Set up indexing step requires a custom Miro app and its credentials. Each person authorizes their own Miro account before using tools.

Feature availability after setup​

Tools and indexed search use different credentials and become available at different points.

CapabilityWhen it becomes availablePermissions
Miro toolsAfter you finish setup, make tools available to the intended users, and each user authorizes their Miro accountThe user's Miro permissions and Glean tool-access settings
Indexed board searchAs Glean crawls and indexes supported board contentThe indexing app's access and each user's Miro board permissions

Authorizing the tools connection does not supply the credentials for indexing. This guide covers the complete tools-and-indexing setup, not a tools-only connection.

Prerequisites​

Before you start, confirm your access in Glean and Miro:

  • Have permission to add and configure connectors in the Glean Admin console.
  • Use a Miro Enterprise plan for board indexing.
  • Have the Miro Company Admin role for indexing. The account that creates the indexing app must also have Content Admin permissions. See Content Admin permissions for Company Admins.

You create the indexing app and obtain its credentials during Set up indexing. You don't need those credentials for the Connect step.

Step 1: Connect Miro​

  1. In the Admin console, go to Connectors, click Add connector, then choose Miro.
  2. Enter a Name for the connector.
  3. Click Connect. Sign in to Miro and approve the requested access.
  4. Return to Glean and continue to Set up indexing after authorization succeeds.

The Connect step connects Miro's hosted MCP server. You don't create a separate custom OAuth app or paste indexing tokens into this step.

Step 2: Set up indexing​

Create a custom app in Miro, then enter its credentials in Glean. This app supplies the access Glean needs to crawl boards and their permissions.

Create the indexing app​

  1. Create a Miro developer team if you don't already have one. See Enterprise Developer teams.
  2. Create an app named Glean in the developer team. See Build your first Hello World app.
  3. Turn on Expire user authorization token.
  4. In the app's Permissions, select the indexing scopes listed in the table.

The indexing app uses these read scopes. They are separate from the permissions requested when you connect Miro tools.

ScopePurpose
boards:readRead boards the app can access
identity:readRead the authorizing user's profile information
team:readRead team information
organizations:readRead organization and organization-member information
organizations:teams:readRead organization teams, their settings, and membership
projects:readRead project information, settings, and membership

Indexing scopes selected in the Miro app permissions

Authorize the indexing app​

  1. Install the app in a Miro team whose boards you want to index. Repeat the installation for each team in scope. See Install the app.
  2. Complete the app's authorization flow to obtain its access token and refresh token. See Miro OAuth 2.0 authorization.
  3. Copy the app's client ID and client secret. Keep both tokens and the client credentials available for the Glean form.
  4. In Miro, go to Settings → Company Profile and copy the company ID from the URL.

For a URL in the form https://miro.com/app/settings/company/{company_id}/settings, copy only the company_id value, not the full URL.

Enter the indexing credentials​

In Glean's Set up indexing step, enter the values from the custom app.

FieldValue
Client IDThe indexing app's client ID
Client SecretThe indexing app's client secret
Access tokenThe access token from the indexing app's authorization
Refresh tokenThe refresh token from the same authorization
Company IDYour Miro company ID

Click Save, then continue to Review setup. The Miro authorization on the Connect step does not replace any of these values.

Step 3: Review setup​

Review the tools connection and indexing configuration. Choose the intended User access, then click Begin indexing to start the initial crawl.

Glean access settings do not grant additional Miro permissions. Users can search only the indexed boards they can access in Miro. Search results appear as Glean processes the boards, so a successful setup does not mean all boards are immediately searchable.

Manage tools​

After setup, open the Miro connector's Tools tab to review the tools available in your workspace. Each user connects their own Miro account before using tools, and Miro enforces that user's board permissions.

Read tools retrieve board information. Write tools change Miro content. Review tool access before making write tools available to users. The hosted server determines the available tools, so the list can change independently of the indexing app's read scopes.

Use the existing controls to manage tool availability:

After setup​

  • Monitor the initial crawl on the Miro connector page in the Admin console.
  • Search for a board in a team where you installed the indexing app. Confirm that the results respect Miro access permissions.
  • Test a read tool using an authorized Miro account before making tools available more broadly.

Troubleshooting​

Use these checks to distinguish tools-connection issues from indexing issues.

IssueWhat to check
The Miro authorization window does not openAllow pop-ups for Glean, then click Connect again.
Tools work, but boards do not appear in searchComplete Set up indexing and Review setup, then check crawl progress and the indexing app's team access.
Indexing credentials fail validationUse the client credentials and tokens from the same custom app. Confirm the app creator has the required Miro admin roles and the app has the indexing scopes.
A board is missing from searchConfirm the app is installed in the board's team, the board contains supported content, and the searching user has access in Miro.

See also​