Skip to main content
Glama
Sign In
Karbon MCP Server

Karbon MCP Server

by Mad-Man-Dan
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List client groups

list_client_groups

Search or retrieve client groups from Karbon using OData filters, pagination, and sorting to manage your client data efficiently.

Instructions

List or search client groups in Karbon. Supports OData filtering, e.g. filter: "contains(FullName,'Smith Family')" or "UserDefinedIdentifier eq 'ABC123'".

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": "list_client_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
topNoMax results to return (1-100, default 100)
skipNoNumber of results to skip, for pagination
filterNoOData $filter expression, e.g. "contains(FullName,'Smith')" or "PrimaryStatus eq 'InProgress'". Operators: eq, ne, gt, ge, lt, le, and, or, contains().
orderbyNoOData $orderby, e.g. "LastModifiedDateTime desc"

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.3

TDQS

A3.6/5.0
Behavior2/5

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

No annotations provided, so the description carries the full burden. It fails to disclose behavioral traits such as pagination behavior (top/skip effects), rate limits, or that the operation is read-only.

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?

Two sentences with no fluff. First sentence states purpose, second provides key example. Could be slightly more structured but remains efficient.

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?

Covers the main functionality with examples, but lacks detail on return value structure, default ordering, and pagination behavior. With no output schema, more guidance on response format would improve completeness.

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 is 100% with parameter descriptions, so baseline is 3. The description adds value only for the 'filter' parameter with examples, not for top, skip, or orderby.

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 action (list or search), resource (client groups), and context (Karbon). The OData filtering detail distinguishes this from sibling tools like get_client_group, update_client_group, etc.

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?

Provides concrete OData filter examples, implying usage scenarios. However, it does not explicitly state when to use this tool versus alternatives (e.g., get_client_group for a single group).

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