Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Update Secret

contract-testing_update_secret
Read-onlyIdempotent

Update an existing secret's name, value, or description for contract testing in SmartBear.

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

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew name for the secret
valueNoNew value for the secret
secretIdYesUUID of the secret to update
descriptionNoNew description
Behavior1/5

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

Description contradicts annotations: annotations include readOnlyHint=true, but the description says 'Update', which is a write operation. This is a serious inconsistency, and no additional behavioral details are provided.

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 description is concise, front-loaded with the purpose, and lists parameters clearly. No extraneous text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description lacks information about return values, error conditions, or permissions. Given the annotation contradiction, more context is needed for completeness.

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 coverage is 100%, so the schema already documents parameters. The description repeats schema descriptions without adding new meaning. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool updates an existing secret's name, value, or description. It uses a specific verb ('Update') and resource ('existing secret'), and differentiates from sibling tools like create_secret and delete_secret.

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 description implies usage for existing secrets but does not explicitly state when to use this tool versus alternatives like create_secret or delete_secret. No guidance on prerequisites or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartBear/smartbear-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server