Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Delete Secret

contract-testing_delete_secret
DestructiveIdempotent

Deletes a secret by its UUID, allowing you to remove stored secrets from the SmartBear testing environment when they are no longer needed.

Instructions

Delete a secret by UUID.

Toolset: Secrets

Parameters:

  • secretId (string) required: UUID of the secret

Input Schema

NameRequiredDescriptionDefault
secretIdYesUUID of the secret

Output Schema

NameRequiredDescriptionDefault
successYesThe operation completed; the API returns no body.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "success": {
+      "const": true,
+      "description": "The operation completed; the API returns no body.",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "success"
+  ],
+  "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 destructiveHint=true, idempotentHint=true, and openWorldHint=false, so the safety profile is documented structurally. The description adds nothing beyond that: it does not say the deletion is permanent, whether a missing UUID errors or succeeds silently, whether dependent integrations using the secret break, or what confirmation the API returns. With annotations covering the hints, the description could still contribute, but here it does not.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core sentence is two clauses and front-loaded with the destructive action. The 'Toolset: Secrets' line and the parameter bullet duplicate structured metadata and could be dropped, but they occupy little space and do not obscure the point.

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?

For a one-parameter mutation with full schema coverage, annotations, and an output schema, the description is minimally sufficient — an agent can call it correctly. It is incomplete on the things structured fields do not cover: permanence of deletion, error behavior for unknown UUIDs, and any downstream effect on pact verification that referenced the secret.

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 the single secretId property is already documented as 'UUID of the secret' in the schema. The description's parameter block restates that verbatim, adding no format, sourcing, or validation meaning. Baseline 3 applies when the schema does all the work.

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 states a specific verb and resource ('Delete a secret') and identifies the identifier used ('by UUID'), so an agent knows exactly what operation this performs. It stops short of naming how it differs from siblings like contract-testing_update_secret or contract-testing_get_secret, relying on the tool name and the word 'Delete' to carry that distinction.

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 guidance on when to use this tool versus updating or listing secrets, no prerequisite or permission notes, and no warning about irreversibility before calling it. The only implicit cue is the verb 'Delete' in the name.

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