Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Update Webhook

contract-testing_update_webhook
Idempotent

Update a webhook's configuration in SmartBear contract testing by modifying events, request details, consumer/provider restrictions, or enable/disable the webhook.

Instructions

Update an existing webhook's configuration.

Toolset: Webhooks

Parameters:

  • webhookId (string) required: UUID of the webhook to update

  • description (string): Human-readable description

  • events (array): Events that trigger this webhook

  • request (object): HTTP request to send when triggered

  • consumer (object): Restrict to a specific consumer

  • provider (object): Restrict to a specific provider

  • enabled (boolean): Whether the webhook is enabled

  • teamUuid (string): UUID of the owning team

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventsNoEvents that trigger this webhook
enabledNoWhether the webhook is enabled
requestNoHTTP request to send when triggered
consumerNoRestrict to a specific consumer
providerNoRestrict to a specific provider
teamUuidNoUUID of the owning team
webhookIdYesUUID of the webhook to update
descriptionNoHuman-readable description
Behavior3/5

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

Annotations indicate idempotentHint=true and destructiveHint=false, which the description does not reiterate or expand upon. The description adds no behavioral context beyond what annotations provide, such as whether the update is partial or full replacement, or error handling if the webhook doesn't exist.

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 concise (one sentence plus a well-formatted parameter list). The parameter list is structured but somewhat redundant given the schema. Still, it is clear and easy to scan.

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

Completeness2/5

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

The description does not mention the return value (e.g., the updated webhook or success status), error conditions, or prerequisites. For a tool with 8 parameters and no output schema, this lack of context reduces completeness.

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 description lists parameters with brief descriptions, but the input schema already provides full descriptions for all parameters (100% coverage). Therefore, the description adds minimal additional meaning beyond the schema.

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?

The description clearly states the action ('Update') and the resource ('webhook's configuration'), making the purpose unambiguous. However, it does not distinguish this tool from sibling tools like 'contract-testing_create_webhook' or 'contract-testing_delete_webhook'.

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?

No explicit guidance on when to use this tool versus alternatives. For example, it does not state that this tool should be used when modifying an existing webhook rather than creating a new one. Given the presence of sibling CRUD tools, this omission impacts usability.

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