Skip to main content
Glama

List records

fawtar_list
Read-only

List records from any Fawtar resource, with filtering, sorting and paging.

Resources:

  • invoices: إصدار الفواتير الضريبية وقراءتها.

  • credit_notes: تصحيح فاتورة صادرة بالخصم.

  • debit_notes: تصحيح فاتورة صادرة بالزيادة.

  • quotes: عروض الأسعار قبل تحوّلها إلى فواتير.

  • orders: طلبات المتجر قبل الفوترة.

  • customers: بيانات العملاء وأرقامهم الضريبية والعنوان الوطني.

  • products: المنتجات والخدمات وأسعارها.

  • categories: تصنيفات المنتجات.

  • product_unit_types: وحدات بيع المنتجات.

  • vendors: بيانات الموردين.

  • bills: فواتير الموردين ببنودها.

  • simple_bills: مصروف بمبلغ واحد دون بنود.

  • bill_payments: سداد فواتير الموردين.

  • inventories: المستودعات والفروع.

  • inventory_levels: الكميات المتاحة لكل منتج في كل مستودع.

  • inventory_adjustments: زيادة أو إنقاص كمية بسبب جرد أو تلف.

  • inventory_transfers: نقل كمية بين مستودعين.

  • invoice_payments: تسجيل دفعة على فاتورة.

  • receipts: الدفعات نفسها بصيغة سند القبض.

  • accounts: شجرة الحسابات وأنواعها.

  • journal_entries: القيود المرحّلة إلى دفتر الأستاذ.

  • recurring_journals: جدولة القيود التي تتكرر كل فترة.

  • employees: بيانات الموظفين ورواتبهم وبدلاتهم.

  • payroll_runs: المسيّرات الشهرية وإجمالياتها.

  • payslips: قسيمة كل موظف داخل المسيّر.

  • assets: سجل الأصول وإهلاكها.

  • pos_tables: طاولات صالة المطعم.

  • pos_orders: طلبات نقاط البيع المفتوحة والمحصّلة.

Filters use the form {"field_predicate": "value"} — for example {"status_eq": "issued"} or {"issued_at_gteq": "2026-01-01"}. Predicates: eq, not_eq, cont, start, end, gt, gteq, lt, lteq, in, null. Only fields the resource allows are honoured; anything else is ignored.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "resource": "<resource>"
    },
    "name": "fawtar_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page number.
sortNoSort as "field asc" or "field desc".
limitNoHow many records to return, 1 to 100.
filtersNoRansack-style filters, e.g. {"status_eq":"issued"}.
resourceYesWhich resource to list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"How many records to return, 1 to 100."
    • addedInput schema / properties / page / description
      Added value: +"1-based page number."
  2. 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 and destructiveHint=false, so safety is covered; the description adds real behavioral context by disclosing that only whitelisted fields are honoured and that unknown filters are silently ignored — a critical trait an agent could otherwise misuse. It stops short of describing pagination metadata or return shape.

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?

The purpose is front-loaded in a single clause, followed by the resource table and then filter syntax — a sensible information hierarchy. The resource list is long and partly restates the enum, but with 28 values it largely earns its space by disambiguating similarly named resources.

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 a generic list endpoint it covers the three things an agent needs — resource selection, filter grammar, sort/paging defaults — and no output schema exists, so return-value detail is not required. Minor gap: no mention of what a response envelope or total-count looks like for paging decisions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline would be 3, but the description goes beyond it: it names the full predicate vocabulary (eq, not_eq, cont, start, end, gt, gteq, lt, lteq, in, null) and gives worked filter examples, which the schema only gestures at. The per-resource glosses also add meaning beyond the bare enum strings.

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?

States a specific verb and resource scope ('List records from any Fawtar resource, with filtering, sorting and paging') and enumerates the 28 supported resources with one-line semantic glosses, so an agent knows exactly what the tool does. It does not explicitly distinguish itself from siblings such as fawtar_get or fawtar_outstanding, leaving that boundary to inference.

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?

Usage is implied by the resource glosses (e.g. product_unit_types, inventory_levels) which help pick a resource, but there is no explicit when-to-use guidance and no statement of when to prefer fawtar_get over this list tool. No exclusions or prerequisites are given.

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.

Resources