Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Execute Webhook

contract-testing_execute_webhook

Triggers a test execution for a specific webhook by its UUID, enabling validation of contract testing workflows.

Instructions

Trigger a test execution of a specific webhook.

Toolset: Webhooks

Parameters:

  • webhookId (string) required: UUID of the webhook

Input Schema

NameRequiredDescriptionDefault
webhookIdYesUUID of the webhook

Output Schema

NameRequiredDescriptionDefault
logsNo
_linksNo
messageNo
requestNo
successNo
responseNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "EmbeddedLink": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "href": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "templated": {
      +          "type": "boolean"
      +        },
      +        "title": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "_links": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "try-again": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "webhook": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "logs": {
      +      "type": "string"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "request": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "body": {},
      +        "headers": {
      +          "additionalProperties": {},
      +          "properties": {},
      +          "type": "object"
      +        },
      +        "url": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "response": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "body": {},
      +        "headers": {
      +          "additionalProperties": {},
      +          "properties": {},
      +          "type": "object"
      +        },
      +        "status": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "success": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false and destructiveHint=false, so the safety profile is covered structurally. Beyond that, the description only restates the title: it never says that this dispatches a real outbound HTTP request to the webhook's configured URL, whether that side effect is recorded in the audit/execution history, or whether failures of the target endpoint surface as errors.

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 core sentence is front-loaded and short, but the '**Toolset:** Webhooks' line and the '**Parameters:**' block are boilerplate that repeats the already-complete input schema. The one substantive sentence is buried under templated scaffolding.

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

Completeness3/5

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

With only one required parameter, an output schema present, and annotations covering safety, the definition is minimally sufficient to invoke the tool. It falls short on the two things an agent actually needs here: differentiating it from the plural test_execute_webhooks sibling and understanding that the call has a real external side effect.

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% for the single parameter, and the description's 'webhookId (string) required: UUID of the webhook' merely duplicates the schema text verbatim. No added meaning such as where to obtain the UUID or whether it accepts a webhook name instead.

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?

States a specific verb and resource: 'Trigger a test execution of a specific webhook.' An agent can tell this acts on one webhook, but the description never names the closely related sibling contract-testing_test_execute_webhooks (which presumably fires all webhooks), leaving the singular/plural distinction to inference from the tool name alone.

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?

There is no when-to-use guidance, no prerequisites (e.g. the webhook must already exist and be configured), and no mention of when to prefer this over contract-testing_test_execute_webhooks or contract-testing_get_webhook. The agent must infer usage entirely from the name.

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

Deploy Server

Other Tools