Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Record Deployment

contract-testing_record_deployment

Record that a specific version of a pacticipant has been deployed to an environment, including support for blue-green deployment instances.

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

TableJSON 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')
Behavior3/5

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

Annotations provide no safety hints (readOnlyHint=false, destructiveHint=false). The description adds that it records a deployment, but does not disclose limitations, side effects, or error conditions beyond what is implied.

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

Conciseness5/5

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

The description is concise, with a single-sentence purpose, a toolset label, and a bulleted parameter list. Every element serves a purpose and is front-loaded.

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 simple record operation, the description covers parameters well. However, it lacks output details and behavioral notes (e.g., idempotency, error handling). Given no output schema and minimal annotations, completeness is adequate but not exhaustive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the description lists all parameters with clear explanations of their meaning and required status. This adds value beyond the schema by grouping and presenting them in a structured manner.

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 clearly states the tool records a deployment of a pacticipant version to an environment. It uses a specific verb ('Record') and resource ('deployment'), and is distinguishable from sibling tools like 'record_release'.

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 description mentions 'Toolset: Environments and Deployments' but does not specify when to use this tool over alternatives or provide exclusions. Usage context is implied but not explicit.

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

Install Server

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