Skip to main content
Glama

workspace_info

Read-only

Retrieves compact workspace identity and counts so you can choose relevant change or document lists before fetching files.

Instructions

Compact workspace identity and counts. Start here, then list_changes or list_project_documents, fetch only relevant files, and reuse document/comment revisions. Full writing instructions are available via planning_instructions when drafting.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "workspace_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
knownRevisionNo
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds workflow behavior — fetch only relevant files, reuse document/comment revisions — but says nothing about what counts are exposed, output shape, or what knownRevision does behaviorally. Useful context without full disclosure.

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?

Purpose is front-loaded in the first sentence, and every phrase carries an actionable instruction. The second sentence is a dense run-on mixing several distinct pieces of advice, which slightly hurts scanability, but nothing is superfluous.

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?

For a two-param, read-only info tool with no output schema, the description gives enough to invoke it and know where to go next. However, an agent still can't predict what 'identity and counts' concretely returns or how to use knownRevision, which is the one gap a complete definition here should close.

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

Parameters2/5

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

Schema coverage is only 50%: workspacePath is well documented in the schema, but knownRevision is undocumented there. The phrase 'reuse document/comment revisions' is only a loose gesture at knownRevision — it doesn't say whether it's a token to pass back, what happens if it's stale, or the format. The description fails to compensate for the coverage gap on the one parameter that needs it.

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?

"Compact workspace identity and counts" names the specific resource and what's returned, and the routing hints (list_changes, list_project_documents) let an agent tell this apart from its siblings. It's clear but terse — 'identity and counts' could be more explicit about the shape of what you get back.

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?

"Start here" is an explicit entry-point directive, and the description names the natural next steps (list_changes, list_project_documents, planning_instructions when drafting). It never states when *not* to use it, but the routing to alternatives is more concrete than most.

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