Skip to main content
Glama

Get KB Sync Connector-Credential Pair

lyzr_kb_sync_cc_pairs_get
Read-onlyIdempotent

Fetch a specific connector-credential pair by ID to retrieve its configuration for knowledge base synchronization.

Instructions

Fetch a connector-credential pair by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cc_pair_idYesThe connector-credential pair id
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so safety and idempotency are covered. The description adds no additional behavioral context, such as return format, error behavior, or not-found handling. With robust annotations, a neutral score is appropriate since the description adds minimal value beyond them.

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 with no redundant phraseology. It conveys the essential action and target without wasting words.

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 simple single-parameter getter with no output schema, the description is adequate for basic selection. However, it does not describe the return payload or any special nuances of connector-credential pairs. Given the low complexity and strong annotations, a middle score is justifiable.

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 for the only parameter cc_pair_id is 100% because its description ('The connector-credential pair id') fully explains it. The description's 'by id' aligns with the parameter but adds no extra semantic detail beyond what the schema already provides.

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 'Fetch a connector-credential pair by id' provides a specific verb (Fetch), a clear resource (connector-credential pair), and retrieval method (by id). This clearly distinguishes it from sibling tools like lyzr_kb_sync_cc_pairs_list (list all) and mutation tools like create/pause/resume.

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 when you have a known cc_pair_id and need a single pair. However, it does not explicitly state when to use this over siblings, nor does it mention exclusions or alternatives. The sibling naming (list, create, etc.) provides implicit context, but no direct guidance is given.

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/nandanNM/lyzr-mcp'

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