Skip to main content
Glama

Nopaque TotalPath

Get Digital Connector

getDigitalConnector
Read-onlyIdempotent

Get one saved connector by id: name, type, targetRef and its connection settings, as in listDigitalConnectors. Use when: a digital test config names a connectorId and you want to say which bot it reaches. Read-only. Needs digital:read. Returns 404 if the connector is not in your workspace.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "getDigitalConnector"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Goes beyond the annotations by disclosing the required scope (digital:read) and the failure mode (404 when the connector is not in your workspace). The annotations already cover read-only, idempotency, and closed-world behavior, so this is solid added context, though nothing is said about response shape beyond field names.

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?

Dense and front-loaded: identity and returned fields first, then the when-to-use trigger, then the operational constraints. No filler sentences.

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

Completeness5/5

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

With rich annotations and an output schema present, the description only needs to add scope, usage trigger, and error behavior — all of which it does for this single-parameter lookup tool.

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

Parameters4/5

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

Schema coverage is 0%, so the description must carry the load; it explains that `id` is the connectorId referenced from a digital test config, giving the parameter concrete meaning beyond the bare uuid format in 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?

States a specific verb and resource ("Get one saved connector by `id`") plus the fields returned (name, type, targetRef, connection settings). The singular framing against the named sibling listDigitalConnectors makes the distinction clear without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit triggering scenario: a digital test config names a connectorId and you want to know which bot it reaches. It does not explicitly say when to prefer listDigitalConnectors or another sibling, but the singular-vs-list framing is strongly implied.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.