Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Record Deployment

contract-testing_record_deployment

Record a deployed version of a pacticipant in a specified environment, including an optional application instance, to track contract-testing deployment state.

Instructions

Record that a version of a pacticipant has been deployed to an environment.

Toolset: Environments and Deployments

Parameters:

  • pacticipantName (string) required: Name of the pacticipant that was deployed

  • versionNumber (string) required: Version number that was deployed

  • environmentId (string) required: UUID of the target environment

  • applicationInstance (string): Identifies a specific instance when multiple instances of the same application are deployed to the same environment (e.g. 'blue', 'green')

Input Schema

NameRequiredDescriptionDefault
environmentIdYesUUID of the target environment
versionNumberYesVersion number that was deployed
pacticipantNameYesName of the pacticipant that was deployed
applicationInstanceNoIdentifies a specific instance when multiple instances of the same application are deployed to the same environment (e.g. 'blue', 'green')

Output Schema

NameRequiredDescriptionDefault
uuidNo
_linksNo
targetNo
_embeddedNo
createdAtNo
currentlyDeployedNo
applicationInstanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$defs": {
+    "Contact": {
+      "additionalProperties": {},
+      "properties": {
+        "details": {
+          "additionalProperties": {},
+          "properties": {},
+          "type": "object"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedNamed": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {
+          "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"
+    },
+    "EmbeddedVersion": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "number": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Environment": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "teams": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedTeam"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "pb:currently-deployed-deployed-versions": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "pb:currently-supported-released-versions": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "pb:environments": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "contacts": {
+          "items": {
+            "$ref": "#/$defs/Contact"
+          },
+          "type": "array"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "isDefault": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "production": {
+          "type": "boolean"
+        },
+        "teamUuids": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "environment": {
+          "$ref": "#/$defs/Environment"
+        },
+        "pacticipant": {
+          "$ref": "#/$defs/EmbeddedNamed"
+        },
+        "version": {
+          "$ref": "#/$defs/EmbeddedVersion"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "applicationInstance": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "currentlyDeployed": {
+      "type": "boolean"
+    },
+    "target": {
+      "type": "string"
+    },
+    "uuid": {
+      "type": "string"
+    }
+  },
+  "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, idempotentHint=false, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds nothing behavioral beyond that — notably silent on what idempotentHint=false means in practice (e.g. whether re-recording the same version creates a duplicate record) and on any permission requirements for writing to an environment.

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 opening purpose sentence is well front-loaded and efficient. However, roughly two-thirds of the text is a parameter table duplicating the input schema verbatim, which consumes space without adding information.

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 an output schema present, the description needn't explain return values, and required-versus-optional params are covered by the schema. Still, for a non-idempotent write to an environment, it omits prerequisites (existing environment ID, existing pacticipant) and duplicate-handling behavior, leaving real gaps.

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 description's parameter list is a verbatim restatement of those schema descriptions, adding no new meaning. Per the high-coverage baseline, a 3 is appropriate, but the redundancy is worth noting.

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: 'Record that a version of a pacticipant has been deployed to an environment.' This distinguishes it from most siblings, though it never contrasts with the closely related contract-testing_record_release, leaving the deployment-vs-release boundary for the agent to infer.

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 explicit when-to-use guidance: nothing says when to record a deployment versus a release, nor that the pacticipant and environment must already exist. The agent must infer the usage context entirely from the tool name and purpose sentence.

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