Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Collaborator: Edit Remote System Configuration

collaborator_edit_remote_system_configuration
Read-onlyIdempotent

Edit the title and configuration JSON of an existing remote system configuration in Collaborator to update its parameters.

Instructions

Edits parameters of an existing remote system configuration in Collaborator. Only title and config are editable after creation.

Toolset: Remote System Configuration Management

Parameters:

  • id (string) required: ID of the remote system Configuration to edit.

  • title (string): Remote system title.

  • config (string): JSON string containing configuration parameters for the remote system.

  • reviewTemplateId (string): Optional review template ID used by this remote system.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesID of the remote system Configuration to edit.
titleNoRemote system title.
configNoJSON string containing configuration parameters for the remote system.
reviewTemplateIdNoOptional review template ID used by this remote system.
Behavior1/5

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

The description states 'Edits parameters', a write operation, but the annotations set readOnlyHint to true. This is a direct contradiction. Additionally, the description does not disclose any other behavioral traits such as required permissions or side effects, leaving the agent with inconsistent information.

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 with one primary sentence and a bullet list of parameters. However, the parameter list is redundant with the input schema and the toolset line adds minimal value. It is front-loaded with the action but contains some unnecessary repetition.

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?

Given the tool has 4 parameters, no output schema, and annotations that include a contradiction, the description fails to provide sufficient context. It does not explain return values, side effects, or resolve the inconsistency about which fields are editable. The contradiction with both annotations and schema leaves the agent underinformed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While the schema coverage is 100%, the description adds the constraint that only title and config are editable, which contradicts the schema's inclusion of reviewTemplateId as a parameter. This creates confusion rather than adding value. The parameter descriptions in the description simply mirror the schema without deeper explanation.

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 'Edits' and the resource 'existing remote system configuration' in Collaborator. It distinguishes this tool from siblings like create, delete, test, and webhook update by specifying that it edits parameters after creation.

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?

The description mentions that only title and config are editable after creation, but the input schema also includes reviewTemplateId as an editable parameter. This contradiction provides misleading guidance on when to use this tool versus alternatives like recreating the configuration.

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