Skip to main content
Glama

sdk-list_annotations

List Exeris SDK annotations from the authoring contract with name, package, targets, retention, and purpose, then filter by package, target, or query string.

Instructions

List Exeris SDK annotations from the authoring contract: name, qualified name, package, targets, retention, and purpose. Supports optional filtering by package (e.g. 'system', 'security', 'capability', or full package name), target (e.g. 'METHOD', 'TYPE', 'FIELD'), or query string.

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": "sdk-list_annotations"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNoOptional case-insensitive search string matching annotation name or purpose.
targetNoOptional ElementType target filter, e.g. 'TYPE', 'METHOD', 'FIELD', 'PARAMETER'.
packageNoOptional package filter, e.g. 'system', 'security', 'capability', or full package name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the returned field set and that filtering is optional, but says nothing about ordering, result size, or pagination for what could be a long catalog, and never explicitly states the operation is read-only and safe to repeat.

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?

Two sentences with the payload description front-loaded and the filter capability second. Efficient, though the example values for package and target duplicate what the schema already lists and could be trimmed.

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

Completeness4/5

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

With no output schema, the description usefully enumerates the fields a caller gets back, which is the main missing piece an agent would otherwise lack. Remaining gap, result ordering and volume, is minor for a simple filtered list tool.

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 description coverage is 100%, so all three filters are already documented, including examples and case-insensitivity. The description restates the same package and target examples verbatim and adds no semantics beyond the schema, so baseline 3 applies.

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 and resource ('List Exeris SDK annotations from the authoring contract') and even enumerates the fields returned: name, qualified name, package, targets, retention, purpose. It stops short of naming the obvious sibling (sdk-describe_annotation) to distinguish list-vs-detail, so it is clear but not fully differentiated.

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?

'Supports optional filtering by package, target, or query string' implies the filtering use case, but there is no explicit when-to-use or when-not-to-use guidance, and no pointer to sdk-describe_annotation for single-annotation detail. Usage is inferable rather than stated.

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