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 for contract testing. Adjust events, request payload, consumer/provider filters, team ownership, or enabled status by webhook ID.

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
Install Server

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already indicate this is a mutating, non-destructive, idempotent operation, and the description adds little beyond that: it only says 'update existing webhook's configuration.' It does not clarify whether omitted optional fields are preserved or reset, what happens if the webhook does not exist, or what the response contains.

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

Conciseness2/5

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

The opening sentence is concise and clear, but the description then duplicates the entire parameter list that already exists in the schema. The bullet list adds length without value, so not every part of the description earns its place.

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?

For a mutation tool with eight parameters and nested objects, the description is too thin: it does not state whether the update is a full replacement or partial update, does not describe the result or errors, and does not connect to sibling tools like get_webhook or create_webhook. The schema covers parameter semantics but not operational context.

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 description coverage is 100%, so the input schema already documents every parameter and its meaning. The description repeats these parameter names and short descriptions but adds no new semantics, validation detail, or guidance beyond the schema.

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 states a clear verb and resource: 'Update an existing webhook's configuration.' The word 'existing' distinguishes it from creation, and the tool name plus sibling names like create_webhook and delete_webhook reinforce the intended operation.

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 phrase 'existing webhook' implies this tool is for modifying an already-created webhook rather than creating a new one, but it does not explicitly state when to choose this over alternatives or mention prerequisites such as fetching the webhook first. Usage guidance is implied, not stated.

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

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