Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Create Environment

contract-testing_create_environment

Create a new deployment environment in PactFlow by specifying a unique name and production status, optionally assigning owning teams and a display name.

Instructions

Create a new deployment environment in PactFlow.

Toolset: Environments and Deployments

Parameters:

  • name (string) required: Unique name for the environment (e.g. 'production', 'staging')

  • production (boolean) required: Whether this is a production environment

  • displayName (string): Human-readable display name

  • teamUuids (array): UUIDs of teams that own this environment

Input Schema

NameRequiredDescriptionDefault
nameYesUnique name for the environment (e.g. 'production', 'staging')
teamUuidsNoUUIDs of teams that own this environment
productionYesWhether this is a production environment
displayNameNoHuman-readable display name

Output Schema

NameRequiredDescriptionDefault
nameNo
uuidNo
_linksNo
contactsNo
_embeddedNo
createdAtNo
isDefaultNo
teamUuidsNo
updatedAtNo
productionNo
displayNameNo

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"
      +    },
      +    "EmbeddedTeam": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "_links": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "self": {
      +              "$ref": "#/$defs/EmbeddedLink"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "isDefault": {
      +          "type": "boolean"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "uuid": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "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"
      +}
  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, destructiveHint=false, idempotentHint=false and openWorldHint=false, so the safety profile is known without the description. The description adds nothing beyond that: it does not say what happens on a duplicate name (the 'unique name' wording implies a conflict error but is not stated), what permissions are required, or whether the new environment becomes immediately usable for deployments.

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 sentence and toolset line are well front-loaded, but the entire 'Parameters' block duplicates the schema text word for word and therefore does not earn its place. Roughly half the description is redundant padding.

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 values need not be explained, and the annotations cover safety. For a create mutation, however, the description omits the failure modes and permission/scoping context (what teamUuids actually gate) that an agent needs to call it correctly and interpret errors.

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 the schema already documents all four parameters with the same wording; the description's parameter list is a verbatim restatement and adds no new meaning. Baseline 3 applies when the schema carries the parameter documentation.

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 states a concrete verb and resource ('Create a new deployment environment in PactFlow') and names the owning toolset, so an agent can distinguish it from reads like contract-testing_list_environments or mutations like contract-testing_update_environment. It stops short of explicitly contrasting with those siblings, which keeps it at 4 rather than 5.

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 when-to-use guidance: no mention of prerequisites (a PactFlow account/team, permissions), no note that update_environment should be used to modify an existing environment instead, and no warning that creating an environment with an existing name will fail. The description is purely declarative.

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