Skip to main content
Glama

eventbroker_get_subscription

Read-onlyIdempotent

Retrieve a subscription by its ID using the Event Broker API to inspect or verify subscription details in VCF Automation.

Instructions

Retrieves Subscription Retrieves Subscription by id. GET /event-broker/api/subscriptions/{id}

Input Schema

NameRequiredDescriptionDefault
idYesthe id of Subscription (path)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, and the description adds nothing beyond the HTTP route. It doesn't disclose what a subscription object contains, what happens on a missing id, or any permission requirements, so it contributes no behavioral context the agent didn't already have.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Very short, which is good, but the first line ('Retrieves Subscription') is pure duplication of the title and the second line repeats the same verb-resource pairing. Front-loaded GET route is fine, but two of three lines carry no new 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?

For a single-path read tool with full annotation coverage and a fully documented one-parameter schema, the description is minimally sufficient. It omits any note on the response shape or failure behavior, which is the only remaining burden it could have carried.

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?

With only one parameter at 100% schema description coverage ('the id of Subscription (path)'), the baseline is 3. The description's 'by id' merely echoes the schema and adds no format guidance (e.g., subscription UUID vs. name).

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?

States the verb 'Retrieves' and the resource 'Subscription by id', which is understandable but essentially restates the tool name (eventbroker_get_subscription) and title (GET /event-broker/api/subscriptions/{id}). Nothing distinguishes it from the many sibling read tools such as eventbroker_get_event, eventbroker_get_event_topic, or eventbroker_get_audit_log_filter_entry_by_id.

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?

There is no guidance on when to use this versus the sibling eventbroker read tools; the agent must infer from the name alone. No mention of prerequisites, required permissions, or error conditions (e.g., subscription not found).

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

Deploy Server

Other Tools