Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: List Environments

contract-testing_list_environments
Read-onlyIdempotent

List all environments configured in a Pact Broker or PactFlow workspace, with page number and page size controls to browse results.

Instructions

Retrieve all environments configured in the Pact Broker or PactFlow workspace.

Toolset: Environments and Deployments

Parameters:

  • pageNumber (number): Page number (default: 1)

  • pageSize (number): Results per page (default: 5)

Input Schema

NameRequiredDescriptionDefault
pageSizeNoResults per page
pageNumberNoPage number

Output Schema

NameRequiredDescriptionDefault
_linksNo
_embeddedNo
paginationNo

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"
+    },
+    "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": {
+        "environments": {
+          "items": {
+            "$ref": "#/$defs/Environment"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "pb:environments": {
+          "items": {
+            "$ref": "#/$defs/EmbeddedLink"
+          },
+          "type": "array"
+        },
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "pagination": {
+      "additionalProperties": false,
+      "properties": {
+        "pageNumber": {
+          "type": "number"
+        },
+        "pageSize": {
+          "type": "number"
+        },
+        "totalItems": {
+          "type": "number"
+        },
+        "totalPages": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "pageNumber",
+        "pageSize",
+        "totalItems",
+        "totalPages"
+      ],
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without description help. The description adds only that the data comes from a Pact Broker or PactFlow workspace, which is modest extra context; it says nothing about pagination limits, ordering, or empty results.

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 first sentence is well front-loaded and wastes nothing, but the following 'Toolset' line and the verbatim parameter list duplicate metadata and schema content, inflating the description without adding information.

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?

This is a simple read-only list tool with a full output schema, complete annotations and fully documented parameters, so almost nothing needs to live in the description. Only the relationship to sibling environment tools is left unaddressed.

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 both parameters already carry descriptions and defaults in the schema, so the baseline is 3. The description's parameter block merely restates pageNumber and pageSize with the same defaults, adding no semantics such as maximum page size or ordering behavior.

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 opens with a specific verb+resource, 'Retrieve all environments configured in the Pact Broker or PactFlow workspace', which tells an agent exactly what is returned and where it comes from. It is clearly distinguishable from siblings like get_environment (single) and list_environment_versions (versions), although it never names those alternatives 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?

Usage is only implied by the word 'all' — the agent can infer this is the unfiltered list call. There is no explicit when-to-use versus contract-testing_get_environment or contract-testing_list_environment_versions, and no preconditions or exclusions stated.

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