Skip to main content
Glama

inspect_xcos_model

Read a saved Xcos diagram to list its blocks, links, and recorded outputs, helping you analyze or debug model contents before simulation.

Instructions

Inspect a saved Xcos diagram, including blocks, links, and recorded outputs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
model_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It does not say whether the read is side-effect-free, whether a missing path errors or returns empty, or what the inspection output looks like beyond a rough field list.

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?

A single focused sentence with no waste, front-loading the resource and enumerating outputs. Appropriate length for a one-parameter read tool.

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?

An output schema exists, so return values need not be explained, and there is only one parameter. But with no annotations and no usage routing, an agent gets little help deciding when this beats its many siblings.

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?

Schema coverage is 0%, but there is only one parameter and its name (model_path) is self-explanatory. The description adds no format or sourcing detail, so this lands at the low-coverage baseline rather than above 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?

Specific verb 'Inspect' plus resource 'saved Xcos diagram,' and it enumerates what inspection returns (blocks, links, recorded outputs). It is clear but does not differentiate itself from siblings like list_xcos_blocks or get_xcos_block_source.

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?

No indication of when to use this tool versus list_xcos_blocks, get_xcos_block_source, or validate_xcos_model. It mentions 'saved' models but never states a precondition or selection rule.

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