Skip to main content
Glama

maket_workspace

Open a document page in the live preview, inspect its state, lock or unlock it, fit the workspace view, and process pending user annotations and messages.

Instructions

When to use: every session-level interaction with the live workspace — open a doc/page in the preview, inspect a doc's current state, toggle its lock, and process the user-message queue. For persistent CRUD on documents (create, rename, delete, duplicate, meta, import/export) use maket_doc.

focus — open doc at page page in the live preview (sets active doc + active page). state — summarise doc's current state: canvas, pages with element counts and data-source cursors (collection · mode · row), charte, pending messages. lock — lock or unlock doc. When locked, every doc-scoped mutation refuses until it's unlocked. Pass locked=true/false, or omit to toggle. fit_view — zoom out the client to fit the whole workspace (same as the Maximize button). list_messages — return pending annotations as JSON. With doc, return only that document's messages; without it, return all document and workspace messages. Each message carries docName (or none for workspace scope), pageIndex and elementId for its anchor, text, ts; a note the person changed after sending also carries edited: true and editedAt (epoch ms) — act on the current text. ack_messages — drop the given ids from whichever bucket they live in.

Input Schema

NameRequiredDescriptionDefault
docNoThe document in scope. Required for focus/state/lock. For list_messages, pass an exact document name to read only its annotations; omit to read all document and workspace messages.
idsNoFor ack_messages: message ids to mark processed.
pageNoFor focus: 1-based page number to make active.
actionYesOperation to run. See the tool description for the action table.
lockedNoFor lock: true to lock the document, false to unlock. Omit to toggle.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.2.0
    • changedInput schema / properties / doc / description
      Previous value: -"The document in scope. Required for focus/state/lock. Do not pass it for list_messages; that action returns every queued user message across all documents and the workspace."New value: +"The document in scope. Required for focus/state/lock. For list_messages, pass an exact document name to read only its annotations; omit to read all document and workspace messages."
  2. Changed1 schema field changedv1.7.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and largely meets it: it discloses that locking makes every doc-scoped mutation refuse until unlocked, that focus mutates active doc/page, and that ack_messages drops ids from 'whichever bucket they live in'. It also surfaces the `edited`/`editedAt` semantics and the instruction to act on current text. It does not mention auth/permission requirements or failure modes, which keeps it short of a 5.

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 with the when-to-use clause, then a scannable per-action breakdown where each line earns its place. Dense but not padded; slightly long, though the length is justified by six distinct actions.

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?

For a multi-action tool with no output schema, the description is thorough: it explains the message payload shape (docName, pageIndex, elementId, text, ts, edited flags) that an agent would otherwise have to guess. Safety/error behavior and lock interaction detail beyond mutations refusing are the only modest gaps.

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 already 100%, so the baseline is 3, but the description adds real meaning: per-action parameter usage for `doc`, `page`, `locked`, and `ids`, plus the non-obvious rule that omitting `doc` in list_messages widens to all messages. It goes beyond restating the schema descriptions.

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 scope statement ('every session-level interaction with the live workspace') and enumerates the six concrete actions (focus, state, lock, fit_view, list_messages, ack_messages). It explicitly names the sibling it is not — persistent CRUD belongs to maket_doc — so an agent can route between the two without opening either schema.

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

Usage Guidelines5/5

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

The 'When to use' clause tells the agent exactly when this tool applies, and the follow-up sentence draws the boundary against maket_doc for persistent document CRUD. Each action is annotated with its own condition (e.g. list_messages with/without `doc`, lock omit-to-toggle), leaving little to inference.

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