Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Get Webhook

contract-testing_get_webhook
Read-onlyIdempotent

Get details of a specific webhook by providing its UUID. Useful for retrieving webhook configuration and status.

Instructions

Retrieve details for a specific webhook by UUID.

Toolset: Webhooks

Parameters:

  • webhookId (string) required: UUID of the webhook

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
webhookIdYesUUID of the webhook
Behavior5/5

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

The description aligns with annotations (readOnlyHint=true, idempotentHint=true, destructiveHint=false). It adds no misleading information and clearly indicates a safe read operation. No behavioral traits are hidden.

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

Conciseness5/5

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

The description is minimal and efficient: one sentence stating the purpose, followed by a clear parameter listing. Every element serves a function, and there is no extraneous content.

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?

Given the tool's simplicity (single required parameter, no output schema), the description is complete. It explains what the tool does and the necessary parameter. No additional information is needed for an agent to select and invoke this tool 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?

The input schema already describes webhookId as 'UUID of the webhook' with 100% coverage. The description merely repeats this information in a structured list, adding no extra meaning beyond what the schema provides.

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 'Retrieve details for a specific webhook by UUID,' using a specific verb and resource. It unambiguously distinguishes this from sibling tools like create_webhook, delete_webhook, list_webhooks, and update_webhook.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The purpose is self-evident from the name and description, and the context of siblings makes usage clear. However, there is no explicit 'when to use' or 'when not to use' guidance, which is acceptable for such a straightforward retrieval tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartBear/smartbear-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server