Skip to main content
Glama

Workspace overview

workspace_overview
Read-onlyIdempotent

Returns one current snapshot of a workspace: identity, admitted documents and statements by form, parties, workspace accounts, events, charts, declarations, journal entries, registered documents waiting for submit or for a chart post, public Tasks still working, internal processing effects, open review items by level (requests leave the books incomplete; notices do not), the charts that cannot post (chart_exception), and whether processing is idle. Counts are facts; the read wakes nothing and implies no correctness verdict. next_actions offers submit when registered documents wait for it, post_chart_accounts when journal entries wait for a post, update_standard_chart for each chart with an exception, then the review queue. Read-only and not metered.

Input Schema

NameRequiredDescriptionDefault
workspace_tagYesActive workspace id (the workspace_tag create_workspace and list_workspaces return).

Output Schema

NameRequiredDescriptionDefault
nameYesWorkspace name.
countsYes
engineYesStamped engine build/version identity for the tool result.
statusYesworkspace_overview.
cautionsYesFactual cautions only.
created_atYesWorkspace creation time (ISO-8601).
descriptionNoOptional display prose, present only when stored.
next_actionsNoCallable next steps: submit waiting documents, post charts for waiting journal entries, repair each chart with an exception, then the review queue (present only when any applies).
workspace_tagYesThe workspace, echoed.
processing_idleYesTrue when no processing is queued or running (processing_effects_active is 0). A submission Task can still be working: counts.tasks_working counts those, and wait_for_workspace_idle waits for both.
chart_exceptionsYesEach active chart that cannot post: chart_id, chart_name, exception_count. update_standard_chart proposes its repair, to register and post.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, destructiveHint false, openWorldHint false), and the description adds genuinely new behavior facts: 'the read wakes nothing', 'not metered', and 'implies no correctness verdict' — the last being an important caveat about what the counts mean. It does not discuss cost, size limits, or staleness of the snapshot, but that is a minor residual gap.

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 one-line purpose, then the enumeration, then behavior caveats, then next_actions — a sensible ordering. The middle enumeration is a long run-on clause; each item is defensible as scope disclosure, but the list is dense enough that it could be trimmed slightly without losing 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?

Output schema exists, so return-shape explanation is unnecessary, and the description still covers what is included, what the counts mean semantically, mutation/side-effect profile, and the recommended follow-up calls. A reader still has to infer ordering/consistency guarantees within the snapshot, which keeps it below top marks for a tool this broad.

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?

Only one parameter (workspace_tag) and schema description coverage is 100%, with the schema itself explaining it is the active workspace id returned by create_workspace and list_workspaces. The description adds no format, validation, or error semantics for it, so this sits at the baseline 3 where the schema does all the work.

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 ('Returns one current snapshot of a workspace') and then enumerates exactly which resources the snapshot aggregates: documents and statements by form, parties, accounts, events, charts, declarations, journal entries, review items. That enumeration makes the aggregation scope distinguishable from the single-resource list_* siblings without opening any 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 strong downstream routing via next_actions ('submit when registered documents wait', 'post_chart_accounts when journal entries wait for a post', 'update_standard_chart for each chart with an exception, then the review queue'), and the review-level note 'requests leave the books incomplete; notices do not' is real decision guidance. It stops short of explicitly saying when to prefer this aggregation over calling list_review_items / list_charts / list_parties individually.

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