Skip to main content
Glama

Get a workspace overview

get_workspace
Read-onlyIdempotent

Read a workspace's connected repositories, integration status, plan status, default model and your role. Available to every workspace member. Reads only; does not change settings or connections.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>"
    },
    "name": "get_workspace"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspace_idYesThe workspace id (from whoami).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description still adds value beyond that by stating the permission level (every member) and enumerating the returned fields, though it says nothing about behavior on an invalid or inaccessible workspace_id.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences: contents first, access second, non-mutating guarantee last. Every sentence carries distinct information and nothing is repeated from the schema or annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter, closed-world read tool with no output schema, the field enumeration effectively stands in for a return-value description, and the access and read-only statements close the remaining questions an agent would have before calling it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is only one parameter and schema coverage is 100%, with the schema itself noting the id comes from whoami. The description adds no further meaning about the parameter, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ("Read a workspace's...") and enumerates exactly what is returned: repositories, integration status, plan status, default model, and the caller's role. This distinguishes it from siblings such as whoami (identity) and list_members (membership) without needing their schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"Available to every workspace member" establishes the access precondition, and "Reads only; does not change settings or connections" implies mutating operations live elsewhere. It stops short of naming a specific alternative for changing settings, so it is clear context rather than full when/when-not routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources