Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Update Webhook

contract-testing_update_webhook
Read-onlyIdempotent

Update a webhook's configuration, including trigger events, HTTP request settings, and optional consumer/provider restrictions.

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
Behavior1/5

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

Annotations declare readOnlyHint=true, indicating a read-only operation, but the description says 'update', which is a write operation. This contradiction is severe. The description does not clarify the actual behavior, permissions needed, or whether the update is partial or full. No output schema provided.

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?

The description is structured with a summary and bullet points, but the parameter list largely duplicates the schema, making it less concise. It could omit the parameter details and reference the schema instead.

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?

With 8 parameters, no output schema, and a contradictory annotation, the description fails to provide a complete picture. It does not explain return values, side effects, or the behavior of the update (e.g., partial vs full replacement). The required parameter webhookId is not highlighted as mandatory.

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?

Schema coverage is 100%, so the description's parameter list repeats schema info without adding new meaning (e.g., constraints, defaults, or inter-parameter relationships). Baseline 3 is appropriate as the description does not degrade but also does not enhance understanding.

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 'Update an existing webhook's configuration,' which specifies the verb (update) and resource (webhook). However, it does not differentiate from sibling tools like 'create_webhook' or 'delete_webhook', leaving some ambiguity.

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 guidance on when to use this tool versus alternatives. It does not mention prerequisites, such as the webhook ID being required, nor does it specify when not to use it (e.g., if read-only access is needed).

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