Skip to main content
Glama

get_webhook

Read-only

This account's webhook (url + last delivery status; never the secret). Free read.

    Args: api_key (read scope). Cost=free. Returns {url, created_at, last_delivery_status,
    last_delivery_at, events}. Errors: unauthorized, not_found (none registered),
    rate_limited.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNoAPI key for this call. Omit to fall back to the Authorization: Bearer / X-API-Key request header (streamable-HTTP only), then the VHGENGINE_API_KEY env var (the stdio default). No key resolvable -> unauthorized.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoThe registered endpoint.
eventsNoEvent types being delivered.
created_atNoRegistration time, ISO-8601 UTC.
last_delivery_atNoWhen that attempt happened, ISO-8601 UTC.
last_delivery_statusNoStatus of the most recent delivery attempt.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / api_key / description
      Added value: +"API key for this call. Omit to fall back to the Authorization: Bearer / X-API-Key request header (streamable-HTTP only), then the VHGENGINE_API_KEY env var (the stdio default). No key resolvable -> unauthorized."
    • addedOutput schema / description
      Added value: +"This account's webhook. The secret is NEVER returned again."
    • addedOutput schema / properties
      Added value: +{
      +  "created_at": {
      +    "description": "Registration time, ISO-8601 UTC.",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "events": {
      +    "description": "Event types being delivered.",
      +    "type": [
      +      "array",
      +      "null"
      +    ]
      +  },
      +  "last_delivery_at": {
      +    "description": "When that attempt happened, ISO-8601 UTC.",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "last_delivery_status": {
      +    "description": "Status of the most recent delivery attempt.",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "url": {
      +    "description": "The registered endpoint.",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  }
      +}
    • removedOutput schema / title
      Removed value: -"get_webhookDictOutput"
  2. Added

TDQS

A4.2/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description adds critical behaviors: it never returns the secret, is free, requires read-scoped API key, and lists specific errors (unauthorized, not_found, rate_limited). This rich context helps the agent anticipate side effects and failure modes.

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?

The description is front-loaded with the main purpose, followed by a structured Args/Errors list. It is compact but slightly dense in the second sentence; still every sentence earns its place, though it could be split for readability.

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

Completeness5/5

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

With an output schema present and thorough annotations, the description covers all essential context: return fields, error modes, authentication requirements, and cost. No critical gaps are apparent for a single-parameter read operation.

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?

The input schema already covers the api_key parameter with 100% description coverage, including fallback mechanisms. The description adds only a minor 'read scope' note, which is already implied by the tool's read-only nature. Schema does the heavy lifting, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool retrieves the account's webhook URL and delivery status, explicitly excluding the secret. This distinguishes it from siblings like set_webhook, delete_webhook, and list_webhook_deliveries, which handle different aspects or collections.

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 description implies use when you need the account webhook details, but does not explicitly contrast with alternatives like list_webhook_deliveries or get_hook. No when-not-to-use or alternative references are provided, so guidance is implied rather than explicit.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources