Skip to main content
Glama

Read the workspace data store

get_workspace_data
Read-only

Read a workspace key-value store to fetch a specific key or list entries by prefix with paging; use keysOnly to audit keys, sizes, and timestamps without loading values.

Instructions

Reads the per-workspace key-value store — the same data blocks read/write via the store global. Give a key to fetch one entry, or omit it to LIST entries (optionally filtered by prefix, paged with limit + after). Values are JSON. Read-only. Pass keysOnly:true when you are deciding WHICH keys to act on — you get key, size and timestamps without the values, which is usually a fraction of the reply and tells you everything a cleanup or an audit needs.

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": {
      "workspaceId": "<workspaceId>"
    },
    "name": "get_workspace_data"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyNoFetch this exact key. Omit to list.
afterNoPaging cursor: the nextAfterKey from a previous list call.
limitNo
prefixNoList only keys starting with this prefix.
keysOnlyNoList keys, sizes and timestamps WITHOUT the values. Use it to decide what to read or delete.
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.53.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, and the description reiterates "Read-only", which is redundant rather than additive. It does add real context — values are JSON, listing is paged via limit+after with nextAfterKey, and keysOnly returns key/size/timestamps without values — but says nothing about error behavior, missing keys, or limits on list size. Useful, though partially duplicative of the schema.

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?

Front-loaded and structured: mode switch first, output shape second, the keysOnly recommendation last. The final clause ("which is usually a fraction of the reply and tells you everything a cleanup or an audit needs") restates the same keysOnly guidance the schema already carries, so there is some removable bulk.

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, so the description correctly explains return shape (JSON values, and key/size/timestamps under keysOnly). However, for a six-parameter tool the required workspaceId is unaddressed and there is no mention of behavior on a missing key or of list-result caps — gaps an agent will hit quickly.

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

Parameters4/5

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

Schema coverage is 67%; the description covers five of six parameters and explains the key/omitted-key switch that the schema leaves implicit. The required workspaceId parameter is never mentioned in the description, and limit/after get only a paging hint, so it adds meaning without fully compensating for the coverage gap.

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 and resource (reads the per-workspace key-value store) and anchors it to a concept the agent already knows (the `store` global). It also splits the tool's two modes explicitly — give a `key` to fetch one entry, omit it to LIST — so an agent can tell it apart from set_workspace_data and delete_workspace_data without opening a schema.

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?

Gives a concrete when-to-use rule for keysOnly ("when you are deciding WHICH keys to act on ... a cleanup or an audit") and names the paging pattern. It never states when not to use it or points at a sibling tool, so the routing guidance is clear but not exhaustive.

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