Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Can I Deploy

contract-testing_can_i_deploy
Read-onlyIdempotent

Check whether a specific service version is safe to deploy to a target environment by analyzing all consumer-provider contract verifications for compatibility.

Instructions

Performs a comprehensive compatibility check to determine whether a specific version of a service (pacticipant) can be safely deployed into a given environment. It analyzes the complete contract matrix of consumer-provider relationships to confirm that all required integrations are verified and compatible.

Toolset: Can I Deploy

Parameters:

  • pacticipant (string) required: The name of the pacticipant (application/service) being evaluated for deployment

  • version (string) required: The version of the pacticipant that you want to check if it's safe to deploy

  • environment (string) required: The target environment where the pacticipant version will be deployed (e.g., 'production', 'staging', 'test')

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionYesThe version of the pacticipant that you want to check if it's safe to deploy
environmentYesThe target environment where the pacticipant version will be deployed (e.g., 'production', 'staging', 'test')
pacticipantYesThe name of the pacticipant (application/service) being evaluated for deployment
Install Server

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds meaningful behavioral context by explaining that it analyzes the complete contract matrix of consumer-provider relationships and confirms all required integrations are verified. This goes beyond the annotations, though it does not disclose the exact result format or whether the tool returns a boolean, report, or matrix.

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 paragraph is focused and communicates the core purpose efficiently. However, the parameters section duplicates what the input schema already documents, and the 'Toolset: Can I Deploy' line adds little value. It is not overly long, but it contains redundant material.

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?

The description explains the operation's intent and required inputs well, but there is no output schema and no description of what the tool returns. The meaning of 'safe to deploy' is only implied, and an agent might need to know whether the result is a boolean, a detailed compatibility report, or something else. The annotations cover read-only and idempotent behavior but not the result shape.

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 parameter descriptions in the tool description are essentially identical to those in the input schema. The description adds no new semantics for the parameters, so the baseline score of 3 is appropriate.

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 operation: performing a compatibility check to determine whether a specific pacticipant version can be safely deployed to a given environment. It also specifies the resource (pacticipant) and the analysis of the contract matrix. However, it does not explicitly differentiate this from siblings like contract-testing_matrix or contract-testing_get_currently_deployed_versions, so it stops short of 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the usage scenario: checking deploy safety before deployment. It gives the required inputs and mentions the target environment, so an agent can infer when to invoke it. However, it provides no explicit guidance about when not to use it, nor does it mention alternatives such as contract-testing_matrix or related verification tools.

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

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