Skip to main content
Glama

describe_sheet

Write a sheet card with purpose, sources, port types, carried signals and simulation cases for Copperflow schematic documentation and testing.

Instructions

Write a sheet's card: does (one line), sources, each port's type and what it carries, cases for simulate. "" or [] removes. One history entry. Limits and a good card: guide { topic: "modules" }.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "file": "<file>"
    },
    "name": "describe_sheet"
  }
}

Input Schema

NameRequiredDescriptionDefault
doesNo
fileYes
casesNoe.g. [{ "name": "24 V in", "set": { "IN": 24, "GND": 0 }, "expect": { "OUT": [3.2, 3.6] } }]
portsNoe.g. { "IN": { "type": "input", "carries": "0-24 V" } }
sourcesNo

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?

With no annotations, the description carries the full burden and does disclose two real behaviors: empty string or empty array removes entries, and the operation produces exactly one history entry (undo-relevant). It omits whether the write replaces the entire card or merges with existing values, and says nothing about permissions or the response.

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?

Extremely compact and front-loaded, with the field list first and the removal/history rules after. The telegraphic fragments ('does (one line)', '"" or [] removes') slightly hurt readability but no sentence is wasted.

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 5-parameter mutation tool with nested objects and no annotations or output schema, the description covers the important fields and removal semantics and routes the agent to guide for limits. It still leaves gaps on overwrite-vs-merge behavior and whether the sheet must already exist.

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 only 40%, but the description compensates well by naming four of five parameters and giving semantics: does is one line, sources, each port's type and what it carries, and cases are consumed by simulate. Only the required 'file' parameter goes unexplained.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The verb+resource combination ('Write a sheet's card') is specific, but 'card' is unexplained jargon and the enumeration of fields (does, sources, ports, cases) is what actually conveys the purpose. An agent can infer this writes documentation metadata for a sheet, but it is not distinguished from siblings like make_sheet or guide.

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 explicit when-to-use or when-not guidance. The phrase 'cases for simulate' and the pointer 'guide { topic: "modules" }' hint at relationships to siblings but never state the condition under which this tool should be chosen, nor any prerequisites such as the sheet existing.

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