Skip to main content
Glama
dragosh29

Amiqus MCP server

by dragosh29

List clients

list_clients
Read-onlyIdempotent

Filter and fetch Amiqus onboarding client records by name, reference, organisation, decision status, assignee, archive state and deletion deadline.

Instructions

Clients (the people being onboarded) with name, decision status (pending/approved/rejected, or none yet), reference, retention date and timestamps. Filter by a fuzzy search on names, reference and organisation name; by status; active or archived; assignee; exact reference; deletion-date bucket; and sort by name or date. Uses GET /clients. Emails, phone numbers, dates of birth and National Insurance numbers only with include_contact_details.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoAPI page number to start from (1-based, as documented; use next_page from a previous call)
searchNoCase-insensitive fuzzy search on first, middle and last name, reference and organisation name (API parameter `search`)
statusNoOnly clients with this decision status (`status`)
sort_byNoSort field (`sort_by`; ID order by default)
assigneeNoOnly clients assigned to this team member's user ID (`assignee`)
order_byNoSort direction (API parameter `order_by`; ascending by default)
referenceNoExact, case-insensitive match on the client reference (`reference`)
visibilityNoOnly active or only archived clients (`visibility`; both by default)
max_resultsNoMost records to return in this call; whole API pages only (up to 100 per page), so fewer may come back with a next_page to continue from
deletion_dateNoOnly clients whose deletion date is in this bucket (`deletion_date`)
include_contact_detailsNoInclude each client's email address, landline, mobile, date of birth and National Insurance number, and stop redacting emails, phone numbers, dates, postcodes and NI/NHS numbers typed into names and references. Off by default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint, so the safety profile is covered. The description adds genuinely useful disclosure not in the annotations: contact data (emails, phones, DOB, NI numbers) is gated behind include_contact_details and otherwise redacted, and it names the underlying endpoint GET /clients. It doesn't discuss paging behavior in prose (that lives in max_results), which keeps it below a 5.

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?

Three sentences, zero filler, front-loaded with what a client is and what is returned, then filters, then the sensitive-data caveat. The middle filter sentence is dense but each clause maps to a real parameter.

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 no output schema, the description usefully enumerates returned fields and the sensitive-data gate, which is the main completeness burden for an 11-param list tool. Pagination semantics and continuation via next_page are left entirely to the schema, so the definition is near-complete rather than fully self-contained.

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% with 11 well-documented parameters, so the schema does the heavy lifting and the baseline of 3 applies. The prose recap of the filter surface adds confirmation but no syntax or format detail beyond the schema, and its 'sort by name or date' phrasing is looser than the schema's six-value sort_by enum.

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?

Names the verb (list) and resource (clients) and disambiguates the resource with the parenthetical 'the people being onboarded', which separates it from list_records and list_client_records. It also enumerates the returned fields (name, decision status, reference, retention date, timestamps), so an agent knows exactly what this collection contains.

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?

The description clearly states the usable filter and sort surface (fuzzy search, status, visibility, assignee, exact reference, deletion-date bucket, sort order), which tells the agent when this tool can answer a query. It stops short of naming the single-client alternative (get_client) or the condition that selects it, so it reads as strong context without explicit routing.

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