Skip to main content
Glama
Sign In
Karbon MCP Server

Karbon MCP Server

by Mad-Man-Dan
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get client group

get_client_group

Retrieve a client group by its Karbon key or your own external identifier, with optional expansion of related business card and team data.

Instructions

Get a single client group by ClientGroupKey — or by your own UserDefinedIdentifier — optionally expanding related data (BusinessCard, ClientTeam). Includes the group's members (contacts and organizations). Provide exactly one of clientGroupKey or userDefinedIdentifier.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
expandNoComma-separated related data to include: BusinessCard, ClientTeam
clientGroupKeyNoThe Karbon ClientGroupKey
userDefinedIdentifierNoLook up by your own external ID instead of the ClientGroupKey

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.3

TDQS

A4.2/5.0
Behavior3/5

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

Describes what is returned (members, expanded data) but lacks details on auth, rate limits, or error behavior. Adequate for a simple read operation, though could be richer.

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?

Two sentences front-loaded with action and identifiers. No wasted words, every sentence adds essential information.

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

Completeness4/5

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

No output schema, but description covers returned data (members, expanded entities). For a get tool with 3 params, it is fairly complete. Minor gap: no behavior when both keys provided.

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 100%, but description adds value by clarifying mutual exclusivity of identifiers and purpose of expand, going beyond property descriptions.

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?

Clearly states the tool retrieves a single client group by one of two identifiers, with optional expansion. Distinguishes from list_client_groups by specifying singular retrieval.

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?

Explicitly requires exactly one of clientGroupKey or userDefinedIdentifier, and explains expand parameter. No alternatives or when-not cases, but sufficient for typical use.

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

Deploy Server

Other Tools