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

# Workspaces

> Centralize project knowledge in Portal for people, Xirp sessions, and other MCP-compatible agents.

A Workspace is a shared knowledge hub in Portal. It brings together software, documentation, links, work items, decisions, people, wiki pages, and Xirp session transcripts.

Workspaces make that context available through MCP. Xirp provides an integrated Workspace experience, but you can also use the Workspace MCP tools from other compatible clients. A coding session can begin by discovering the system it is changing instead of relying only on files in one repository.

## What a Workspace contains

* **Members**: users and teams allowed to access the Workspace
* **Catalog entities**: components, services, APIs, systems, and related software
* **Resources**: repository links, documents, design files, runbooks, Slack channels, pull requests, and other references
* **Records**: decisions, plans, and discussions
* **Wiki pages**: generated or human-maintained knowledge
* **Sessions**: uploaded Xirp transcripts associated with the Workspace

Only invited members and Portal administrators can see the complete Workspace.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-overview-with-resource.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=ad1e91b99f1882dc6852860b6fc1fcb1" alt="A Workspace overview" width="1800" height="1200" data-path="xirp/assets/workspace-overview-with-resource.webp" />

## Create a Workspace

1. Select **New Workspace** in Portal's top navigation, or open **Workspaces** from the sidebar.
2. Enter a title and optional description.
3. Add relevant Software Catalog entities.
4. Add users or teams as members.
5. Review and create the Workspace.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-create-details.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=d99e5ce05652bd25e2f1635acf35fadd" alt="Enter Workspace details" width="1800" height="1200" data-path="xirp/assets/workspace-create-details.webp" />

Attach catalog entities during creation or add them later.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-create-catalog.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=140621a413b69aaca18984076644ee2b" alt="Choose catalog entities for a Workspace" width="1800" height="1200" data-path="xirp/assets/workspace-create-catalog.webp" />

The review step shows the selected catalog entities and members before anything is created.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-create-review.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=706d4bb978df8ff95c63441b4f397f94" alt="Review a new Workspace" width="1800" height="1200" data-path="xirp/assets/workspace-create-review.webp" />

You can also start from a catalog entity page. Portal preselects that entity and its related resources.

## Add members

Select **Add member** in the Workspace. Add an individual user or a team from the Software Catalog. Adding a team gives its current members access according to the Workspace permission model.

The first Portal administrator is responsible for inviting other users to the Portal instance. A Workspace invitation does not replace the instance invitation.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-create-members.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=084b38f433ad12438474e3623056b90f" alt="Choose Workspace members" width="1800" height="1200" data-path="xirp/assets/workspace-create-members.webp" />

The **People** tab lists current members and lets an authorized user add or remove access.

<img src="https://mintcdn.com/spotify-89f50c35/Au6-kNeho5Rk8Vno/xirp/assets/workspace-people.webp?fit=max&auto=format&n=Au6-kNeho5Rk8Vno&q=85&s=41d3abb420782ca06ae171c0fc540e23" alt="Workspace People tab" width="1800" height="1200" data-path="xirp/assets/workspace-people.webp" />

## Workspaces and Xirp

A session launched from a Workspace requires at least one catalog component with a resolvable source repository. If the Workspace has several eligible components, choose which repository Xirp should clone or open.

During the session, the agent can query Workspace context through MCP. After the work is complete, upload the transcript manually to share it with the Workspace.

<CardGroup cols={2}>
  <Card title="Add context" icon="paperclip" href="/docs/xirp/workspaces/adding-resources">
    Add catalog entities, links, documents, work items, and other resources.
  </Card>

  <Card title="Build the wiki" icon="book" href="/docs/xirp/workspaces/wiki-pages">
    Generate, review, and maintain structured knowledge from Workspace
    resources.
  </Card>

  <Card title="Launch Xirp" icon="terminal" href="/docs/xirp/workspaces/launching-sessions">
    Start a context-aware coding session and upload its transcript.
  </Card>

  <Card title="Connect GitHub" icon="github" href="/docs/xirp/github-onboarding">
    Populate the Software Catalog with repositories, users, and groups.
  </Card>
</CardGroup>

## Supported integrations

| Integration  | What it adds                                                                | Setup                                                                                       |
| ------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| GitHub       | Repository metadata, pull requests, and source context for catalog entities | Configure the Portal GitHub App                                                             |
| Linear       | Issues, projects, and status updates                                        | Configure the Linear auth provider; add a webhook secret for real-time updates if available |
| Google Drive | Search, preview, and linked document resources                              | Enable Drive and configure Google OAuth                                                     |

Integration availability depends on your Portal configuration. More integrations are planned.

You can add any useful URL as a Workspace resource. When a session's MCP client has an integration that can access the linked service, the agent may be able to retrieve additional context from that link.
