Skip to main content
Glama

cad_tool_help

Read-only

Retrieve curated help, version details, examples, and risk notes for a specified OSS CAD Suite tool to choose and run HDL workflows safely.

Instructions

Show curated help, version, examples, and risk notes for a suite tool.

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": {
      "request": "<request>"
    },
    "name": "cad_tool_help"
  }
}

Input Schema

NameRequiredDescriptionDefault
requestYes

Output Schema

NameRequiredDescriptionDefault
okNo
riskYes
toolYes
errorNo
notesNo
usageNo
binaryYes
summaryYes
versionNo
examplesNo
help_textNo
recommended_toolNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

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 safety and locality are covered. The description adds content-level context (version, examples, risk notes) beyond the annotations, which is useful, but it omits what happens for an unknown tool name (error vs. empty help) and whether the content is static or version-specific to the installed suite.

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?

One front-loaded sentence of about fifteen words with no filler; the resource ('curated help') comes before the enumeration of contents. The list of four content types is dense but each item carries information.

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 read-only semantics are covered by annotations. For a one-parameter lookup tool the definition is close to sufficient, but the lack of any guidance on the tool-name argument leaves a real gap for invocation correctness.

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% and the single parameter is a nested request.tool string with no description, so the description must compensate. The phrase 'for a suite tool' does establish that the parameter identifies a tool within the suite, but it says nothing about accepted name format or whether tool names must match sibling names exactly.

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?

The description uses a specific verb (Show) and names the concrete payload: curated help, version, examples, and risk notes for a suite tool. It implicitly distinguishes itself from execution siblings like cad_tool_run or cad_tool_search by being a documentation lookup, but it never names those alternatives explicitly.

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

Usage Guidelines3/5

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

Usage is only implied: an agent can infer this is a discovery/help call to be used before invoking an unfamiliar suite tool, but the description never states when to call it, when not to, or how it relates to cad_tool_search. Nothing tells the agent whether it should be called once per tool or cached.

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