Skip to main content
Glama

get_workspace_item

Read-onlyIdempotent

Read a single visible folder, category, or tag by UUID to retrieve workspace details. Discover IDs with list_workspace_structure first; missing or out-of-scope IDs return not found.

Instructions

Read one visible folder, category, or tag by UUID. Folder uses its direct API getter; category and tag lookup uses the complete permission-filtered lists. An absent or out-of-scope ID is reported as not found. Use list_workspace_structure to discover IDs first.

Input Schema

NameRequiredDescriptionDefault
idYesUUID of an item visible to the active API key.
kindYesThe workspace resource type to read by ID.
workspaceIdNoWorkspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv2.0.4
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
    • removedOutput schema / $defs / __schema0 / properties / categoryId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / categoryId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / documents / items / properties / categoryId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / documents / items / properties / categoryId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / documents / items / properties / categoryName / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / documents / items / properties / categoryName / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / documents / items / properties / folderId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / documents / items / properties / folderId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / documents / items / properties / folderName / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / documents / items / properties / folderName / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / documents / items / properties / tags / items / properties / color / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / documents / items / properties / tags / items / properties / color / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / $defs / __schema0 / properties / parentId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / $defs / __schema0 / properties / parentId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "folder",
      -        "type": "string"
      -      },
      -      "result": {
      -        "$ref": "#/$defs/__schema0"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "category",
      -        "type": "string"
      -      },
      -      "result": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": {},
      -            "properties": {
      -              "apiMode": {
      -                "enum": [
      -                  "unavailable",
      -                  "global",
      -                  "category"
      -                ],
      -                "type": "string"
      -              },
      -              "apiPermissionEdit": {
      -                "type": "boolean"
      -              },
      -              "apiPermissionRead": {
      -                "type": "boolean"
      -              },
      -              "apiPermissionWrite": {
      -                "type": "boolean"
      -              },
      -              "createdAt": {
      -                "type": "string"
      -              },
      -              "documentCount": {
      -                "type": "number"
      -              },
      -              "folderCount": {
      -                "type": "number"
      -              },
      -              "id": {
      -                "type": "string"
      -              },
      -              "name": {
      -                "type": "string"
      -              },
      -              "order": {
      -                "type": "number"
      -              },
      -              "updatedAt": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "id",
      -              "name",
      -              "order",
      -              "createdAt",
      -              "updatedAt",
      -              "apiMode",
      -              "apiPermissionRead",
      -              "apiPermissionEdit",
      -              "apiPermissionWrite"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "additionalProperties": {},
      -            "properties": {
      -              "createdAt": {
      -                "type": "string"
      -              },
      -              "documentCount": {
      -                "type": "number"
      -              },
      -              "folderCount": {
      -                "type": "number"
      -              },
      -              "id": {
      -                "type": "string"
      -              },
      -              "name": {
      -                "type": "string"
      -              },
      -              "order": {
      -                "type": "number"
      -              },
      -              "updatedAt": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "id",
      -              "name",
      -              "order",
      -              "createdAt",
      -              "updatedAt"
      -            ],
      -            "type": "object"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "tag",
      -        "type": "string"
      -      },
      -      "result": {
      -        "additionalProperties": {},
      -        "properties": {
      -          "color": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "createdAt": {
      -            "type": "string"
      -          },
      -          "documentCount": {
      -            "type": "number"
      -          },
      -          "id": {
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "name",
      -          "color"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "folder",
      +        "type": "string"
      +      },
      +      "result": {
      +        "$ref": "#/$defs/__schema0"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "category",
      +        "type": "string"
      +      },
      +      "result": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": {},
      +            "properties": {
      +              "apiMode": {
      +                "enum": [
      +                  "unavailable",
      +                  "global",
      +                  "category"
      +                ],
      +                "type": "string"
      +              },
      +              "apiPermissionEdit": {
      +                "type": "boolean"
      +              },
      +              "apiPermissionRead": {
      +                "type": "boolean"
      +              },
      +              "apiPermissionWrite": {
      +                "type": "boolean"
      +              },
      +              "createdAt": {
      +                "type": "string"
      +              },
      +              "documentCount": {
      +                "type": "number"
      +              },
      +              "folderCount": {
      +                "type": "number"
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              },
      +              "order": {
      +                "type": "number"
      +              },
      +              "updatedAt": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name",
      +              "order",
      +              "createdAt",
      +              "updatedAt",
      +              "apiMode",
      +              "apiPermissionRead",
      +              "apiPermissionEdit",
      +              "apiPermissionWrite"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": {},
      +            "properties": {
      +              "createdAt": {
      +                "type": "string"
      +              },
      +              "documentCount": {
      +                "type": "number"
      +              },
      +              "folderCount": {
      +                "type": "number"
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              },
      +              "order": {
      +                "type": "number"
      +              },
      +              "updatedAt": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name",
      +              "order",
      +              "createdAt",
      +              "updatedAt"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "tag",
      +        "type": "string"
      +      },
      +      "result": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "color": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "createdAt": {
      +            "type": "string"
      +          },
      +          "documentCount": {
      +            "type": "number"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "color"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Addedv0.1.3

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, closed-world, non-destructive behavior, but the description adds real value: folder lookup uses a direct API getter while category/tag use permission-filtered lists (a latency/consistency difference), and an absent or out-of-scope ID is surfaced as 'not found' rather than an error. That not-found semantics is the kind of thing an agent needs and cannot infer from annotations.

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?

Four short sentences with zero filler: purpose first, implementation differences second, error semantics third, prerequisite last. Every sentence carries actionable information.

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

Completeness4/5

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

With an output schema present and annotations covering the safety profile, the description's burden is light, and it still covers the two non-obvious behaviors (per-kind lookup mechanism, not-found reporting). The only gap is silence on the optional workspaceId scoping parameter.

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 documents id, kind, and workspaceId, and the enum pins the allowed kinds. The description only restates the three kinds and adds visibility scoping for IDs; it says nothing about the optional workspaceId parameter. Baseline 3 is appropriate.

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?

States a specific verb (Read) plus the exact resource set (one visible folder, category, or tag) scoped to UUID. This cleanly separates it from siblings like save_folder, delete_category, and list_workspace_structure.

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?

Explicitly routes the agent to list_workspace_structure for ID discovery, which is the key prerequisite. It stops short of stating when a caller should prefer a bulk list call over repeated single reads, but the primary usage condition is stated.

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