kimai-mcp-server

List Kimai Customers

kimai_list_customers

Read-onlyIdempotent

List all customers accessible via your Kimai API token. Supports pagination, search, and filtering for efficient customer data retrieval.

Instructions

List customers visible to the Kimai API token from /api/customers. This tool is read-only.

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

Input Schema

Name	Required	Description	Default
`page`	No	Kimai API page number for paginated endpoints.
`size`	No	Kimai API page size. Kimai supports a maximum size of 500.
`term`	No	Optional search term for endpoints that support it.
`order`	No	Optional sort direction.
`visible`	No	Optional visibility filter for endpoints that support it.
`order_by`	No	Optional Kimai orderBy field.
`response_format`	No	Output format: markdown for human-readable summaries, json for structured output.	markdown

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jul 29, 2026

TDQS

A3.9/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, etc. The description adds the scope 'visible to the Kimai API token', which is useful behavioral context beyond the annotations.

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, no fluff, front-loaded with the key purpose. Very concise.

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?

Given 7 parameters and no output schema, the description does not explain return format or pagination behavior. It is adequate but not comprehensive.

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%, so the description adds no extra parameter meaning beyond what is already in the schema. Baseline score of 3 applies.

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 it lists customers visible to the API token, with a specific verb and resource. It distinguishes from sibling tools like kimai_get_customer (single customer) and other list tools.

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?

No explicit guidance on when to use this tool versus alternatives like kimai_get_customer. Usage is implied but not directly stated.

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