Skip to main content
Glama

sdk-describe_annotation

Describe an Exeris SDK annotation by simple or fully qualified name to inspect its package rationale, targets, retention, purpose, attributes, defaults, and deprecation status.

Instructions

Describe a specific Exeris SDK annotation: simple and qualified name, owning package rationale, targets, retention, purpose, detailed description, all attributes (with types, defaults, required-ness, descriptions, and deprecations), and annotation-level deprecation status.

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": {
      "annotation": "<annotation>"
    },
    "name": "sdk-describe_annotation"
  }
}

Input Schema

NameRequiredDescriptionDefault
annotationYesThe annotation name to inspect. Accepts simple name (e.g. 'ExerisDomain', 'Field', 'Validation') or fully-qualified name (e.g. 'eu.exeris.sdk.annotation.ExerisDomain'). Case-insensitive.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

A3.7/5.0
Behavior4/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, and it does so well by disclosing the full shape of the response — targets, retention, attributes with types/defaults/required-ness, and deprecation flags at both attribute and annotation level. It stops short of stating failure behavior for an unknown annotation name or whether results are cached, which keeps it out of 5 territory.

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 front-loaded sentence that begins with the verb and resource before the returned-field enumeration. The long parenthetical about attribute details is dense but every element is a distinct returned field, not padding; a slightly tighter phrasing would earn a 5.

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?

For a one-parameter read tool with no output schema and no annotations, the description's enumeration of returned fields does the work the missing output schema would otherwise do. The remaining gap is error/not-found behavior, which an agent would need to handle correctly.

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%: the schema already documents the simple-name vs fully-qualified-name forms, gives concrete examples, and states case-insensitivity. The description adds nothing about the parameter beyond the schema, so the 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 ('Describe') and resource ('a specific Exeris SDK annotation') and enumerates exactly what the result contains: name, package rationale, targets, retention, attributes, deprecation status. This clearly separates it from a listing tool, though it never names sdk-list_annotations as the alternative for enumerating all annotations.

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?

The word 'specific' plus the singular 'annotation' parameter implies this is for deep-diving on one annotation rather than browsing, but that is inference. There is no explicit statement of when to prefer this over sdk-list_annotations or sdk-list_deprecations, and no prerequisites or exclusions are given.

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