Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Record Deployment

contract-testing_record_deployment
Read-onlyIdempotent

Record the deployment of a pacticipant version to a specific environment, including optional application instance identification for multi-instance setups.

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

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

The annotation declares readOnlyHint=true, implying a read-only operation, but the description states it records a deployment, which is a write operation. This contradiction severely misleads the agent about the tool's behavior. No additional behavioral traits are disclosed.

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?

The description is fairly concise, listing parameters clearly. However, it could be slightly more compact by not repeating parameter descriptions already present in the schema.

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

Completeness2/5

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

The description lacks details about return values, side effects, or prerequisites. The annotation contradiction further undermines completeness. For a simple record tool, basic context is missing.

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 repeats the parameter names and descriptions. It adds no additional meaning beyond what the schema already provides.

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 clearly states the tool records a deployment of a pacticipant version to an environment. It specifies the verb 'record' and the resource. However, it does not differentiate from the sibling tool 'contract-testing_record_release', which likely serves a similar but distinct purpose.

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?

No guidance on when to use this tool vs alternatives like record_release or can_i_deploy. The description provides no prerequisites, exclusions, or context for appropriate invocation.

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