clients module provides tools to search, retrieve, create/link, and
inspect client profile access within the company scope.
Available Tools
search_clients
Search the company’s client list by name or email. Returns paginated client summaries.
- Type: Read-only
- Important Input Fields:
query(string, optional): Search string matched against first name, last name, or email. Max 200 chars.relationshipStatus(string, optional): Filter by status (e.g.active,invited,inactive).page(integer, optional): Page number, starting at 1.limit(integer, optional): Page size, max 50.
get_client
Retrieve a client’s complete profile.
- Type: Read-only
- Important Input Fields:
clientId(string, required): Unique client identifier.
create_client Write
Create a new client profile or link an existing account by email to the company.
- Type: Write
- Important Input Fields:
firstName(string, required): Client first name. Min 2 chars.email(string, required): Client email.lastName(string, optional): Client last name.inviteByEmail(boolean, optional): Whether to send invite email.
inspect_client_data_access
Inspect stored external-data grants and company connection status for a client.
External-data grants are reserved for separately authorized sources such as
future wearable integrations. An empty list does not block company-owned
nutrition or measurements and is separate from the connection’s health consent.
- Type: Read-only
- Important Input Fields:
clientId(string, required): Unique client identifier.
Natural Language Examples
- “Find client Jane Doe in the database.”
- “Create a new client named Tom Hardy with email tom.hardy@example.com.”
- “Inspect the company connection and external-data grants for client 64b64c0f2f5f4c0012345678.”