System Atlas
SystemAtlas

get_workspace

A workspace at a glance: its companies, how much of each is mapped, the client's layer health and top gaps. Needs a key.

Needs a keyMCP tool

Parameters

  • workspacestringrequired

    Workspace slug

Example call

Agents call tools by name; you rarely write this by hand. It is here so you can test the server from a shell or your own code.

{
  "name": "get_workspace",
  "arguments": {
    "workspace": "acme-builders"
  }
}

Response

The result is one text content block holding this JSON (abbreviated here). Errors come back with isError: true and a message such as Error 401: … or Invalid input: ….

Response
{
  "workspace": {
    "slug": "acme-builders",
    "name": "Acme Builders",
    "role": "owner"
  },
  "industry": "Construction",
  "schemaVersion": 3,
  "companies": [
    {
      "slug": "client",
      "name": "Acme Builders",
      "isClient": true,
      "mapped": 0.62,
      "components": 84
    }
  ],
  "topGaps": [
    {
      "primitive": "job_costing",
      "label": "Job costing",
      "kind": "missing",
      "competitorsWith": 3
    }
  ]
}

Over REST

The same call without MCP: GET/api/v1/workspaces/:slug

Previouslist_workspacesNext get_company_atlas