Skip to main content
Glama

signals

Read-only

Search waveform design, scopes, and named nodes by regex path to locate specific objects for debugging. Filter paths with patterns like /uart/ or /_valid$/ instead of listing everything.

Instructions

Search the waveform's design, scopes (instances) and signals, by a regex in slashes found anywhere in the path, as grep does (/uart/, /_valid$/); none lists it all, folded to fit.

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": "signals"
  }
}

Input Schema

NameRequiredDescriptionDefault
patternNoA regex in slashes, found anywhere in the path in any case, indices in brackets (`/s_axi_.*valid/`, `/^top\.cpu\./`, `/gen\[0\]/`); none lists all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.0
    • changedInput schema / properties / pattern / description
      Previous value: -"`*` within a scope level, `**` across (`**.s_axi_*`); without `*`, any path\ncontaining the text. Empty lists all."New value: +"A regex in slashes, found anywhere in the path in any case, indices in brackets\n(`/s_axi_.*valid/`, `/^top\\.cpu\\./`, `/gen\\[0\\]/`); none lists all."
  2. First observedv0.3.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 the safety profile is covered. The description adds the grep-style matching semantics and the phrase 'folded to fit', hinting that results may be folded/truncated, but that hint is too vague to tell an agent whether long result sets are cut off or how.

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 that leads with the verb and the searched resources before the regex mechanics. It is dense but not padded; the trailing 'folded to fit' is the only genuinely murky fragment.

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 one-optional-parameter read tool with annotations and no output schema, the description covers what is searched and that an empty pattern returns everything. It does not say what each result entry contains (path only, or path plus metadata), which an agent would want before parsing output.

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 100% and the single optional parameter already documents the slash-delimited regex, case-insensitivity, bracket indices, and empty-means-all. The description's own examples (`/uart/`, `/_valid$/`) mostly duplicate what the schema shows, adding only the 'matched anywhere in the path' framing.

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?

States a specific verb+resource: search the waveform's design, scopes (instances) and signals by regex over the path, with a grep analogy. The domain objects being searched are enumerated, so an agent can tell it apart from generic siblings like 'find' or 'values', though it never explicitly contrasts with them.

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?

Implicit guidance only: 'as grep does' plus 'none lists it all' tells the agent that omitting the pattern enumerates everything, which is a useful default-behavior cue. There is no explicit when-to-use/when-not statement and no named alternative for related lookups.

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