Skip to main content
Glama

KiotViet MCP by usefulapi

List customers

kiotviet_list_customers
Read-only

List customers (code, name, phone, email, address, debt, total invoiced, reward points, groups). Contains personal data of the shop's customers. Filter by code, name, phone, group or last change. GET /customers.

Input Schema

NameRequiredDescriptionDefault
codeNoCustomer code.
nameNoFilter by customer name.
group_idNoOnly customers in this customer group.
order_byNoSort field.
page_sizeNoRecords per page, 1-100 (default 20).
current_itemNoRecord offset to start from (0 = first record). Pass the previous reply's next_item.
include_totalNoInclude financial totals (debt, total invoiced, points).
contact_numberNoFilter by phone number.
order_directionNoSort direction.
last_modified_fromNoOnly records changed at or after this date-time (shop local time).
include_customer_groupNoInclude each customer's groups.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true. The description adds useful context beyond annotations by noting that the data contains the shop's customers' personal data and by listing returned fields, though it does not discuss auth, rate limits, or pagination behavior.

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?

Three compact sentences front-load the core purpose, then add fields, privacy context, and filters. Every sentence contributes useful information without repetition.

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?

For an 11-parameter list tool with no output schema, the description covers the resource, returned fields, privacy sensitivity, and main filters. Pagination and response-shape details are left to the schema, which is adequate though not fully described in prose.

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 description coverage is 100%, so all 11 parameters are documented in the schema. The description adds only a partial filter summary and does not explain sorting, pagination, or include_* parameters 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?

States a specific verb and resource: "List customers," and enumerates the customer fields returned. This clearly distinguishes bulk listing from the single-customer get_customer/get_customer_by_code siblings.

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 gives filtering context (code, name, phone, group, last change) but does not explicitly say when to use this instead of get_customer or get_customer_by_code. Usage is implied rather than stated as when/when-not guidance.

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.