Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Get Webhook

contract-testing_get_webhook
Read-onlyIdempotent

Retrieve details for a specific webhook by UUID, enabling you to inspect its configuration when managing contract-testing integrations.

Instructions

Retrieve details for a specific webhook by UUID.

Toolset: Webhooks

Parameters:

  • webhookId (string) required: UUID of the webhook

Input Schema

NameRequiredDescriptionDefault
webhookIdYesUUID of the webhook

Output Schema

NameRequiredDescriptionDefault
uuidNo
_linksNo
eventsNo
enabledNo
requestNo
consumerNo
providerNo
teamUuidNo
_embeddedNo
createdAtNo
updatedAtNo
descriptionNo

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"
+    },
+    "EmbeddedTeam": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "isDefault": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "team": {
+          "$ref": "#/$defs/EmbeddedTeam"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "pb:consumer": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:execute": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:pact-webhooks": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:provider": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:webhooks": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "consumer": {
+      "additionalProperties": {},
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "events": {
+      "items": {
+        "additionalProperties": {},
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "provider": {
+      "additionalProperties": {},
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "request": {
+      "additionalProperties": {},
+      "properties": {
+        "body": {},
+        "headers": {
+          "additionalProperties": {},
+          "description": "Request headers. Values support template expressions and auth helper functions.",
+          "properties": {},
+          "type": "object"
+        },
+        "method": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        },
+        "username": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "teamUuid": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "updatedAt": {
+      "type": "string"
+    },
+    "uuid": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false and destructiveHint=false, so the safety profile is fully covered elsewhere. The description adds nothing behavioral beyond that — no note on what happens for a missing/unknown UUID, no pagination or caching detail — so it contributes little on this dimension.

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?

Front-loaded with the core action in the first sentence, and the Toolset/Parameters block is scannable. The parameter bullet duplicates the schema description verbatim, which is mild waste but not harmful.

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

Completeness4/5

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

For a one-parameter read tool with an output schema and rich annotations, this is essentially complete — nothing needed to call it correctly is missing. A sentence on obtaining the UUID or on not-found behavior would have made it a 5.

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% and the single parameter already documents "UUID of the webhook". The description restates the same fact rather than adding format, source (where to obtain the UUID), or error semantics, so it sits at the baseline.

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 names a specific verb and resource ("Retrieve details for a specific webhook") and the lookup key (UUID), so an agent knows exactly what it fetches. It does not explicitly contrast with list_webhooks or the other webhook siblings, which keeps it below a 5.

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 / when-not-to-use guidance and no named alternative, even though siblings like contract-testing_list_webhooks (discovery) and contract-testing_execute_webhook (action) are the obvious forks. The requirement of a UUID only weakly implies the usage pattern.

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