Search clients
Searches the Clients tab by name and returns matching client records.
MCP tool planity_read → list_clients
read
Returns the id, name, email and phone of each match, enough to pick the right client before get_client or create_appointment. Client records are personal data: the result goes to your agent, so keep the query narrow. The tool never lists the whole client file.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Part of the client's name, as typed in the search bar of the Clients tab. |
| include_deleted boolean | boolean | Also search records deleted with Supprimer le client (Afficher les clients supprimés). Default false. |
tools/call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "planity_read",
"arguments": {
"operation": "list_clients",
"arguments": {
"query": "query"
}
}
}
}Example response
{
"content": [
{
"type": "text",
"text": "{ ... same JSON as structuredContent ... }"
}
],
"structuredContent": {
"query": "martin",
"clients": [
{
"client_id": "c_1042",
"name": "Léa Martin",
"email": "client@example.com",
"phone": "+33 6 00 00 00 00"
},
{
"client_id": "c_1190",
"name": "Hugo Martin",
"email": "client2@example.com",
"phone": "+33 6 00 00 00 01"
}
]
},
"isError": false
}