Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: List Labels

contract-testing_list_labels
Read-onlyIdempotent

Retrieve all labels used across a workspace, with page number and page size parameters to control results.

Instructions

Retrieve all labels used across the workspace.

Toolset: Labels

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
pageNo
_linksNo
_embeddedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "EmbeddedLink": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "href": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "templated": {
      +          "type": "boolean"
      +        },
      +        "title": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "Label": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "name": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "Page": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "number": {
      +          "type": "number"
      +        },
      +        "size": {
      +          "type": "number"
      +        },
      +        "totalElements": {
      +          "type": "number"
      +        },
      +        "totalPages": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "_embedded": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "labels": {
      +          "items": {
      +            "$ref": "#/$defs/Label"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "_links": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "next": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "previous": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        },
      +        "self": {
      +          "$ref": "#/$defs/EmbeddedLink"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "page": {
      +      "$ref": "#/$defs/Page"
      +    }
      +  },
      +  "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 by structured data. The description adds only the workspace-wide scope; it says nothing about pagination behavior (whether a pageSize of 5 truncates results silently) or result ordering, which are the traits an agent actually needs here.

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 is well front-loaded and the total length is short. But roughly half the text is a 'Toolset: Labels' line and a parameter block that duplicates the input schema word for word, neither of which earns its place.

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 two-optional-parameter read with an output schema present, so return-value detail is correctly omitted and annotations cover safety. What remains missing is only minor: whether pagination requires iterating pages to get the full label set.

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 plus defaults, so the schema does the work. The description merely restates 'pageNumber (number): Page number (default: 1)' and 'pageSize (number): Results per page (default: 5)' verbatim, adding no meaning such as maximum page size or whether an out-of-range page errors.

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 gives a specific verb and resource ('Retrieve all labels') plus a scope qualifier ('across the workspace'), so an agent knows exactly what is returned. It does not distinguish itself from near siblings such as contract-testing_get_pacticipant_label or contract-testing_list_pacticipants_by_label, which is the only thing keeping it from 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 phrase 'across the workspace' implicitly signals this is the global label listing rather than a per-pacticipant lookup, which is useful routing context. However, no alternative tool is named and there are no stated exclusions or preconditions, so the guidance remains implied rather than explicit.

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