Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Create Pacticipant

contract-testing_create_pacticipant

Register a new application or service in SmartBear contract testing to store its name, main branch, and repository details.

Instructions

Register a new application/service (pacticipant) in the workspace.

Toolset: Pacticipants

Parameters:

  • name (string) required: Name of the pacticipant (cannot be changed after creation)

  • displayName (string): Human-readable display name

  • mainBranch (string): Name of the main/trunk branch (e.g. 'main')

  • repositoryName (string): Repository name

  • repositoryNamespace (string): Repository namespace/organisation

  • repositoryUrl (string): URL of the source repository

Input Schema

NameRequiredDescriptionDefault
nameYesName of the pacticipant (cannot be changed after creation)
mainBranchNoName of the main/trunk branch (e.g. 'main')
displayNameNoHuman-readable display name
repositoryUrlNoURL of the source repository
repositoryNameNoRepository name
repositoryNamespaceNoRepository namespace/organisation

Output Schema

NameRequiredDescriptionDefault
nameNo
titleNo
_linksNo
_embeddedNo
createdAtNo
updatedAtNo
mainBranchNo
displayNameNo
repositoryUrlNo
repositoryNameNo
repositoryNamespaceNo

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"
+    },
+    "EmbeddedNamed": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {
+          "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": {
+        "labels": {
+          "items": {
+            "$ref": "#/$defs/EmbeddedNamed"
+          },
+          "type": "array"
+        },
+        "latest-version": {
+          "additionalProperties": {},
+          "description": "Use latestVersion",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "number": {
+              "type": "string"
+            },
+            "title": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "latestVersion": {
+          "additionalProperties": {},
+          "properties": {
+            "_links": {
+              "additionalProperties": {},
+              "properties": {
+                "self": {
+                  "$ref": "#/$defs/EmbeddedLink"
+                }
+              },
+              "type": "object"
+            },
+            "number": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "teams": {
+          "description": "The teams this pacticipant belongs to. Always embedded on the single pacticipant endpoint, and on the collection endpoint when requested via ?include=teams.",
+          "items": {
+            "$ref": "#/$defs/EmbeddedTeam"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "curies": {
+          "items": {
+            "$ref": "#/$defs/EmbeddedLink"
+          },
+          "type": "array"
+        },
+        "pb:branch-version": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:branches": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:can-i-deploy-badge": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:can-i-deploy-branch-to-environment-badge": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:label": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:teams": {
+          "description": "Links to the admin team resource for each team this pacticipant belongs to. Present whenever the teams are embedded.",
+          "items": {
+            "$ref": "#/$defs/EmbeddedLink"
+          },
+          "type": "array"
+        },
+        "pb:version": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:version-tag": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "pb:versions": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "versions": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "mainBranch": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "repositoryName": {
+      "type": "string"
+    },
+    "repositoryNamespace": {
+      "type": "string"
+    },
+    "repositoryUrl": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "updatedAt": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.3/5.0
Behavior3/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 mutation profile is largely covered. The description adds one genuinely useful behavioral fact — the name "cannot be changed after creation" — which tells the agent the choice is permanent. It stops short of disclosing duplicate-name behavior (relevant given idempotentHint=false) or permission requirements.

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 front-loaded and clear, but the subsequent parameter list duplicates the input schema almost word for word, consuming most of the description's length for zero added information. The toolset line adds little. It is not verbose in tone, but a third of the content is redundant.

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?

With an output schema present, return values need not be explained, and all six parameters are documented. What is missing for a creation tool with idempotentHint=false is the failure mode for an existing name and any preconditions linking repository fields to service setup. Adequate but with clear gaps an agent would hit on first use.

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 input schema already documents all six parameters and the required/minLength constraint on name. The description's parameter block restates the schema text verbatim rather than adding format hints, defaults, or examples beyond the existing 'main' branch example. Baseline 3 applies since the schema does the heavy lifting.

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 gives a specific verb and resource ("Register a new application/service (pacticipant)") and glosses the domain term pacticipant, so an agent knows exactly what entity is being created. It does not explicitly contrast with the sibling tools update_pacticipant, patch_pacticipant, or delete_pacticipant, though the word "new" implicitly separates it from the update variants.

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 through the verb "Register a new" — there is no explicit statement of when to use this versus update_pacticipant/patch_pacticipant, no prerequisites such as required role or token, and no guidance on what to do if the pacticipant already exists. The toolset label "Pacticipants" gives weak grouping context but no selection criteria.

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