Workspace Tools

MCP tools for accessing user profiles, workspaces, and projects

Tools for retrieving your profile, listing workspaces, and navigating projects. All tools in this group are read-only.

userplane_get_profile

Retrieve the authenticated user’s Userplane profile including name, email, and aggregate usage stats (workspace count, recording count, link count).

Parameters: None

Returns: A user object with id, name, and email, plus a stats object with workspaces, recordings, and links counts.

---

userplane_list_workspaces

List Userplane workspaces the authenticated user belongs to. A workspace is a team-level container that holds projects, recordings, links, and members. Returns paginated results.

Parameter	Type	Required	Description
page	number	No	Page number (default: 1)
per_page	number	No	Results per page (default: 5, max: 50)

Returns: Paginated list of workspaces. Each entry includes workspaceId and workspaceName.

---

userplane_get_workspace

Retrieve details for a specific Userplane workspace. The authenticated user must be a member.

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace ID

Returns: workspaceId, workspaceName, createdAt, and a dashboardUrl pointing to the workspace in the Userplane dashboard.

---

userplane_list_projects

List projects in a Userplane workspace. Projects organize recordings and links, each with its own retention policy. Returns paginated results.

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace ID
page	number	No	Page number (default: 1)
per_page	number	No	Results per page (default: 5, max: 50)

Returns: workspaceId, total, and a projects array. Each project includes projectId, projectTitle, isDefault, and recordingRetentionDays.

---

userplane_get_project

Retrieve details for a specific project including title, retention policy, and whether it is the workspace default.

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace ID
projectId	string	Yes	Project ID

Returns: workspaceId, projectId, projectTitle, isDefault, and recordingRetentionDays.

---

Example prompts

List my Userplane workspaces.

List all projects in workspace {workspaceId} and tell me how many recordings each one has.

Related articles

• Recording Tools — tools for listing, inspecting, and analyzing recordings.
• Recording Link Tools — tools for creating and managing recording links.
• Getting Started — first steps after connecting your AI client.