Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Create Secret

contract-testing_create_secret

Create a secret to authenticate webhooks. Specify a name and value, optionally add a description and team UUID.

Instructions

Create a new secret for use in webhook authentication.

Toolset: Secrets

Parameters:

  • name (string) required: Name of the secret

  • value (string) required: Value of the secret

  • description (string): Description of the secret

  • teamUuid (string): UUID of the owning team (cannot be changed after creation)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the secret
valueYesValue of the secret
teamUuidNoUUID of the owning team (cannot be changed after creation)
descriptionNoDescription of the secret
Behavior3/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds that teamUuid cannot be changed after creation, but does not elaborate on rate limits, authorization needs, idempotency, or error conditions.

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

Conciseness5/5

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

The description is a single front-loaded sentence followed by a structured parameter list. Every element is useful, no redundancy.

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?

The tool has no output schema, and the description does not mention what the tool returns (e.g., created secret object). It also lacks context on prerequisites or idempotency, leaving gaps for a complete understanding.

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 baseline is 3. The description's parameter notes mostly echo the schema. The immutability note for teamUuid is also present in the schema, so no additional meaning beyond the schema.

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 verb ('Create'), the resource ('new secret'), and the context ('for use in webhook authentication'). It distinguishes from sibling tools such as update_secret, delete_secret, and list_secrets.

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 webhook authentication but does not explicitly state when to use this tool versus alternatives like update_secret or delete_secret. No explicit 'when-not-to-use' guidance.

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