SmartBear MCP server

Official

by SmartBear

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Contract Testing: Update Secret

contract-testing_update_secret

Idempotent

Update an existing secret's name, value, or description by providing its UUID and new details. Modify stored secrets to keep credentials current.

Instructions

Update an existing secret's name, value, or description.

Toolset: Secrets

Parameters:

secretId (string) required: UUID of the secret to update
name (string): New name for the secret
value (string): New value for the secret
description (string): New description

Input Schema

Name	Required	Description
`name`	No	New name for the secret
`value`	No	New value for the secret
`secretId`	Yes	UUID of the secret to update
`description`	No	New description

Output Schema

Name	Required	Description
`name`	No
`uuid`	No
`_links`	No
`teamUuid`	No	Where no team is provided, the secret is not attached to a team and can only be modified by users with the "secret:manage:*" permission.
`_embedded`	No
`createdAt`	No
`updatedAt`	No
`description`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.43.0Nov 3, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$defs": {
+    "EmbeddedEnvironment": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "production": {
+          "type": "boolean"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "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"
+    },
+    "EmbeddedTeamUser": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "email": {
+          "type": "string"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "identityProviderId": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "const": 0,
+              "type": "number"
+            },
+            {
+              "const": 1,
+              "type": "number"
+            }
+          ]
+        },
+        "typeDescription": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedUser": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "email": {
+          "type": "string"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "identityProviderId": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Team": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "administrators": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedUser"
+              },
+              "type": "array"
+            },
+            "environments": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedEnvironment"
+              },
+              "type": "array"
+            },
+            "members": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedTeamUser"
+              },
+              "type": "array"
+            },
+            "pacticipants": {
+              "items": {
+                "$ref": "#/$defs/EmbeddedNamed"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "isDefault": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "numberOfMembers": {
+          "type": "number"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "team": {
+          "$ref": "#/$defs/Team"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "description": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "teamUuid": {
+      "description": "Where no team is provided, the secret is not attached to a team and can only be modified by users with the \"secret:manage:*\" permission.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "updatedAt": {
+      "type": "string"
+    },
+    "uuid": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

Addedv0.40.0Sep 3, 2026
Removedv0.34.0Aug 7, 2026
First observedv0.27.1Jun 29, 2026

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, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered structurally. The description's 'name, value, or description' hints that only supplied fields change (a partial update), which is a small but real addition beyond annotations. It says nothing about whether the old secret value is discarded or retrievable, whether consumers using the secret are affected, or what permissions are required.

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, but the subsequent 'Toolset' and 'Parameters' blocks duplicate the schema word-for-word and add no information, padding a one-sentence definition into a multi-section block. Every listed parameter already exists with an identical description in the input schema.

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?

This is a simple single-record mutation with a full schema, annotations and an output schema, so return values and safety hints need not be described. What is missing is behavioral nuance an agent would want: partial-update semantics, whether the change takes effect immediately for consumers, and required permissions. Adequate but with clear gaps.

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, and the description's parameter list just restates them verbatim. It adds no meaning such as whether passing null for description clears it, whether value is write-only, or any format constraints on secretId beyond 'UUID'. Baseline 3 is the right ceiling for pure duplication.

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?

States a specific verb and resource ('Update an existing secret') plus the updatable fields (name, value, description). The verb distinguishes it from the sibling create_secret, get_secret, list_secrets and delete_secret by name alone, though the description never names those siblings as boundaries.

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: 'an existing secret' signals this is for secrets that already exist rather than new ones, which indirectly routes the agent away from contract-testing_create_secret. There is no explicit when-to-use/when-not-to, no mention of prerequisites (e.g. needing the secretId from list_secrets or get_secret), and no guidance on partial vs full updates.

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

Deploy Server