Docs: Tool reference
core toolset

get_workspace_overview

Get the workspace overview. Describes the workspace: name, portal and admin URLs, the boards you can see with their categories, the post statuses in order, portal features, and limits to plan around (page and bulk sizes, attachment size, idempotency key lifetime). Members and service accounts also get the internal tags and team size by role. Call it after whoami at the start of a session; use the names and IDs it returns in other tools. No side effects.

Toolset
core
Who can call it
OwnersManagersContributorsCustomersAPI keysVisitors
REST
GET /api/v1/w/{workspace}/overview
Behavior
read-onlyidempotent

Input

No input.

Output

FieldTypeDescription
workspacerequiredobject
portalrequiredobject
brandingrequiredobjectThe portal's look (M5.4).
boardsrequiredarray of objectBoards you can see, in portal order. list_boards has full details.
statusesrequiredarray of objectPost statuses in order; is_default marks the one new posts get.
tagsrequiredarray of object or nullInternal tags, by name; null for end users, who never see tags.
custom_fieldsrequiredarray of object or nullCustom fields on posts, users and companies; null for end users.
segmentsrequiredarray of object or nullSaved segments (for voter_segment filters); null for end users.
roadmapsrequiredarray of object or nullInternal roadmaps (for get_roadmap and on_roadmap filters); null for end users.
team_membersrequiredarray of object or nullTeam members to assign as owners (assign_post_owner); null for end users.
teamrequiredobject or nullTeam size by role; null for end users.
limitsrequiredobject

Calling it

// MCP: tools/call
{ "name": "get_workspace_overview", "arguments": {} }

// Typed client
await carechannel.get_workspace_overview({});