Skip to main content
Glama
Sign In
Production MCP Template

Production MCP Template

by RichFerry
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

workspace_inventory

Read-onlyIdempotent

Inspect the workspace root to generate a bounded inventory summary. Control depth, hidden files, and sample limit for efficient workspace analysis.

Instructions

Inspect the configured workspace root and return a bounded inventory summary.

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_inventory"
  }
}

Input Schema

NameRequiredDescriptionDefault
max_depthNo
include_hiddenNo
sample_limitNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false, so the safety profile is clear. The description adds the term 'bounded', which aligns with openWorldHint=false, but does not disclose any additional behavioral traits like rate limits, authorization needs, or potential side effects. With annotations covering the core aspects, a 3 is appropriate.

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?

The description is a single sentence that efficiently conveys the core purpose. Every word is purposeful with no redundant or extraneous content.

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

Completeness2/5

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

Despite low complexity and the presence of annotations, the description fails to cover key aspects: the meaning of the three parameters (especially max_depth and sample_limit), what a 'bounded inventory summary' includes, and the behavior of include_hidden. An output schema is absent, leaving the agent uninformed about the return format.

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

Parameters1/5

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

Schema description coverage is 0%, meaning the schema provides no descriptions for the three parameters (max_depth, include_hidden, sample_limit). The description does not explain any parameter's meaning, effect, or constraints, leaving the agent without guidance on how to use them.

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?

The description uses the specific verb 'inspect' and clearly identifies the resource ('configured workspace root') and the outcome ('return a bounded inventory summary'). It defines a unique action different from sibling tools like workspace_read_text, design_*, etc.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives (e.g., workspace_read_text for reading file contents, design_* for design tasks). There is no mention of prerequisites or exclusions.

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

Deploy Server

Other Tools