get_webhook
Get webhook subscription details by ID to verify configuration or inspect events.
Instructions
Retrieve a PDFGate webhook subscription by its ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| webhookId | Yes | The webhook ID |
Get webhook subscription details by ID to verify configuration or inspect events.
Retrieve a PDFGate webhook subscription by its ID.
| Name | Required | Description | Default |
|---|---|---|---|
| webhookId | Yes | The webhook ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description must disclose behavioral traits. It states the tool retrieves a subscription, implying a read operation, and likely returns the webhook details; however, it does not mention whether the webhook must belong to the authenticated user, whether it returns a 404 for missing IDs, or any rate limits. The description adds minimal behavioral context beyond the verb 'retrieve'.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, under 15 words, and immediately states what the tool does and its key parameter. There is no filler or redundant detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (one required parameter, no output schema, no nested objects), the description is sufficient to understand the basic operation. However, the lack of usage guidance and behavioral transparency (e.g., error behavior) prevents a higher score, especially since no annotations offload that burden.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter 'webhookId' has a schema description ('The webhook ID') and is required. Schema coverage is 100%, and the description's phrase 'by its ID' corroborates the parameter's role, adding no extra meaning but not detracting. Baseline is 3 for high coverage, and the alignment with the purpose earns a 4 because it reinforces the parameter's necessity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the tool retrieves a webhook subscription by ID, which is clear and differentiates from siblings like create_webhook and delete_webhook. However, it does not specify whether the returned data includes the webhook's URL or events, but the core purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a straightforward when-to-use scenario (retrieve a webhook by ID) but provides no guidance on when not to use it or when to prefer alternatives, such as list operations. Given the sibling set includes other webhook operations, this lack of context is a gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/pdfgate/pdfgate-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server