Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Record Release

contract-testing_record_release

Records a pacticipant version release to a target environment, enabling mobile and library release workflows to track which version is deployed.

Instructions

Record that a version of a pacticipant has been released to an environment (for mobile/library release workflows).

Toolset: Environments and Deployments

Parameters:

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

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

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

Input Schema

NameRequiredDescriptionDefault
environmentIdYesUUID of the target environment
versionNumberYesVersion number that was released
pacticipantNameYesName of the pacticipant that was released

Output Schema

NameRequiredDescriptionDefault
uuidNo
_linksNo
_embeddedNo
createdAtNo
currentlySupportedNo

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"
      +    },
      +    "createdAt": {
      +      "type": "string"
      +    },
      +    "currentlySupported": {
      +      "type": "boolean"
      +    },
      +    "uuid": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.3/5.0
Behavior3/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 the workflow framing but says nothing about the non-idempotent consequence (repeated calls likely create duplicate release records) or what happens when environmentId does not resolve — the details an agent most needs before a mutating call.

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 leading sentence is well-formed and front-loaded, but the bolded 'Parameters' list repeats text already present at 100% coverage in the input schema, so a substantial portion of the description does not earn its place. The Toolset line is mildly useful for discovery context.

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?

An output schema exists, so return-value explanation is not required, and the tool is a simple three-parameter mutation. What is missing is behavioral guidance around the non-idempotent write and its relationship to the deployment-recording sibling, which for a mutation tool leaves a noticeable gap.

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 all three parameters are already documented in the schema, and the description's parameter block restates them nearly verbatim. It adds no semantics beyond the schema — no format hints for versionNumber, no guidance on where environmentId UUIDs come from.

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 first sentence names a specific verb and resource — recording that a pacticipant version was released to an environment — and the parenthetical narrows it to mobile/library release workflows. This is enough to separate it from the neighboring contract-testing_record_deployment, though that sibling is never named explicitly.

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 '(for mobile/library release workflows)' clause implies when this tool applies rather than when deployment recording applies, leaving the agent to infer the split with contract-testing_record_deployment. No prerequisites are stated, such as the environment having to exist first via contract-testing_create_environment or the pacticipant needing to be registered.

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