Skip to main content
Glama

KiotViet MCP by usefulapi

List cash flow

kiotviet_list_cashflow
Read-only

List cash-book entries (receipts and payments: code, branch, method, partner, amount, date, status). Filter by branch, direction or date range. GET /cashflow.

Input Schema

NameRequiredDescriptionDefault
codeNoVoucher code.
end_dateNoDate 2026-10-01 or date-time 2026-10-01T08:00:00 (shop local time).
page_sizeNoRecords per page, 1-100 (default 20).
branch_idsNoOnly these branches (see kiotviet_list_branches).
is_receiptNotrue = receipts (money in), false = payments (money out).
start_dateNoDate 2026-10-01 or date-time 2026-10-01T08:00:00 (shop local time).
current_itemNoRecord offset to start from (0 = first record). Pass the previous reply's next_item.
partner_nameNoCustomer, supplier or other partner name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/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, so the safety profile is covered. The description adds meaningful context by naming the GET endpoint and listing the returned cash-book fields. It does not cover authentication, rate limits, or default ordering, but for a read-only list tool this is a reasonably transparent definition.

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 two compact sentences plus the endpoint, with the core purpose front-loaded. It lists returned fields efficiently and adds the filtering capability without filler. Every part earns its place for an agent trying to understand the tool quickly.

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?

With eight optional parameters, full schema coverage, and rich read-only annotations, the definition is nearly complete. Listing the returned fields compensates for the lack of an output schema. It could still say more about pagination behavior or ordering, but the schema covers the pagination parameter.

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 the schema already documents all eight parameters thoroughly. The description groups the filters into branch, direction, and date range, which maps to several parameters but does not add syntax or detail beyond the schema. Baseline 3 is appropriate because the schema carries most of the parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: list cash-book entries, specifically receipts and payments. It enumerates the main entry fields and endpoint, making the tool's scope clear. It does not explicitly distinguish this from sibling list tools such as invoices or orders, so it falls short of a 5.

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?

It says the entries can be filtered by branch, direction, or date range, which gives implied usage context. However, it does not state when to use this tool versus alternatives, nor does it provide exclusions or prerequisites. There is no sibling tool for cash flow specifically, but the guidance remains implicit.

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.