Skip to main content
Glama
delano
by delano

get_workspace

Retrieve detailed information about a Postman workspace by providing its ID. Optionally include additional data to customize the response.

Instructions

Get details of a specific workspace

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceYesWorkspace ID
includeNoAdditional data to include in response

Implementation Reference

  • Schema definition for 'get_workspace' tool, requiring 'workspace' (string ID) and optional 'include' parameter.
    {
      name: 'get_workspace',
      description: 'Get details of a specific workspace',
      inputSchema: {
        type: 'object',
        properties: {
          workspace: {
            type: 'string',
            description: 'Workspace ID',
          },
          include: {
            type: 'string',
            description: 'Additional data to include in response',
          },
        },
        required: ['workspace'],
      },
    },
  • Handler function 'getWorkspace' that validates workspace_id and makes a GET request to /workspaces/{workspace_id} with optional include parameter.
    async getWorkspace(workspace_id: string, include?: string): Promise<ToolCallResponse> {
      if (!workspace_id) {
        throw new McpError(ErrorCode.InvalidParams, 'workspace_id is required');
      }
      const response = await this.client.get(`/workspaces/${workspace_id}`, {
        params: { include }
      });
      return this.createResponse(response.data);
    }
  • Routing in handleToolCall that dispatches 'get_workspace' to this.getWorkspace(args.workspace, args.include).
    case 'get_workspace':
      return await this.getWorkspace(args.workspace, args.include);
  • Input schema for 'get_workspace' with properties: workspace (string, required) and include (string, optional).
    {
      name: 'get_workspace',
      description: 'Get details of a specific workspace',
      inputSchema: {
        type: 'object',
        properties: {
          workspace: {
            type: 'string',
            description: 'Workspace ID',
          },
          include: {
            type: 'string',
            description: 'Additional data to include in response',
          },
        },
        required: ['workspace'],
      },
Behavior2/5

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

No annotations provided, so the description must carry full burden. It only states a read operation ('Get details') without disclosing authorization needs, rate limits, or side effects. Minimal behavioral transparency.

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

Conciseness4/5

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

Very concise single sentence that is front-loaded. It earns its place but could be slightly more structured or informative without sacrificing brevity.

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

Completeness3/5

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

No output schema exists, and the description does not explain what details are returned. While functional for a simple getter, it lacks completeness for an agent to fully understand the tool's output.

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?

Schema description coverage is 100%, so the schema already adequately documents parameters. The description adds no additional meaning beyond what is in the schema, leading to a baseline score.

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

Purpose4/5

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

The description 'Get details of a specific workspace' clearly states the action and resource. However, it does not differentiate from sibling tools like get_workspace_roles or get_workspace_tags, which also fetch workspace details.

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

Usage Guidelines3/5

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

No explicit guidance on when to use this tool versus alternatives like list_workspaces. The usage is implicitly clear for fetching a single workspace, but lacks when-to-use or when-not-to-use context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/delano/postman-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server