Connected Agents Tools Reference

This guide lists every Claras connected agent tool with its name, description, and parameters.

Tool availability still follows your Claras role and practice settings. Destructive tools delete or remove records. Prefer list and get tools before create or delete.

Overview

There are 38 tools. Names use a resource_action pattern (for example meetings_create). Lists are paginated (default 25, max 100) where noted in the tool description. Async work (submit, generate, upload processing) returns quickly; poll the matching status tool until the work finishes.

Agents do not author meeting or document templates. Template list and get tools exist so create tools can resolve template ids.

Tools by resource

You and your practice

Tool	Description	Parameters	Notes
`me_get`	Return the authenticated user profile, their active practice, and every practice or team they belong to (with role).	None	Read only

Clients

Tool	Description	Parameters	Notes
`clients_create`	Create a client in the active practice. Optional profile_id assigns an adviser or owner.	`name` (string, required): The client's full name `profile_id` (string, optional) `emails` (array, optional): The client's email addresses	‎
`clients_delete`	Soft-delete a client by id.	`id` (string, required): Client id to delete	Destructive
`clients_get`	Get a client by id. Set include_record to true for the living client record HTML.	`client_id` (string, required): Client id `include_record` (boolean, optional): Include the client record HTML when true (default false)	Read only
`clients_list`	List clients in the active practice. Paginated (default 25, max 100).	`query` (string, optional): Search by client name `scope` (string, optional): everyone (default) or only clients assigned to you `page` (number, optional): 0-based page index (default 0) `limit` (number, optional): Page size, max 100 (default 25)	Read only
`clients_update`	Update a client's name, assigned adviser, emails, or anniversary.	`id` (string, required): Client id `name` (string, optional): The client's full name `profile_id` (string, optional) `emails` (array, optional): The client's email addresses `anniversary` (string\|null, optional): Anniversary as YYYY-MM-DD, or null to clear	‎

Meetings

Tool	Description	Parameters	Notes
`meetings_create`	Create a meeting for a client from a meeting template. Call templates_meetings_list first to get a template_id.	`client_id` (string, required): Client id the meeting is for `template_id` (string, required): Meeting template id to base it on `date` (string, optional)	‎
`meetings_delete`	Delete a meeting by id.	`id` (string, required): Meeting id to delete	Destructive
`meetings_export_file_note_docx`	Export the meeting file note as a DOCX. Requires non-empty note content (usually after processing). Returns a short-lived signed download URL; fetch promptly (expires in minutes). Does not finalise the meeting.	`meeting_id` (string, required): Meeting id whose file note to export as DOCX	Higher rate limit cost
`meetings_finalise`	Finalise a processed meeting file note.	`meeting_id` (string, required): Meeting id to finalise	‎
`meetings_get`	Get a meeting by id. Opt in to include_note (markdown) and include_transcript.	`meeting_id` (string, required): Meeting id `include_note` (boolean, optional): Include the file note as markdown (default false) `include_transcript` (boolean, optional): Include the transcript text (default false)	Read only
`meetings_get_status`	Get the processing status of a meeting (cheap poll after meetings_submit).	`meeting_id` (string, required): Meeting id	Read only
`meetings_list`	List meetings. Pass client_id for that client, otherwise list the practice inbox (statuses default to common open states).	`client_id` (string, optional): When set, list meetings for this client only `query` (string, optional): Search term `statuses` (enum, optional): Filter by meeting status (inbox list only) `order_by` (string, optional): Inbox list sort (default date)	Read only
`meetings_submit`	Submit a meeting for file note processing. With a recording attached (meetings_update_recording), transcribes then processes. With a transcript only, processes directly. Returns immediately; poll meetings_get_status until processed or failed.	`meeting_id` (string, required): Meeting id to submit for file note generation `people_count` (number, required): Number of people who attended the meeting	Higher rate limit cost
`meetings_update`	Reschedule a meeting to a new date and time (date only).	`meeting_id` (string, required): Meeting id `date` (string, required): New scheduled date and time as a UTC ISO 8601 timestamp	‎
`meetings_update_recording`	Attach an uploaded audio or video file as this meeting recording. Flow: files_request_upload → PUT bytes → files_complete_upload → meetings_update_recording → meetings_submit. Do not use attachments_create for meeting recordings.	`meeting_id` (string, required): Meeting id to attach the recording to `file_id` (string, required)	‎
`meetings_update_transcript`	Replace the meeting transcript text. Expensive: may run PII redaction. Prefer meetings_update_recording for audio or video files.	`meeting_id` (string, required): Meeting id `transcript` (string, required) `source` (string, optional): How the transcript was provided	Higher rate limit cost

Documents

Tool	Description	Parameters	Notes
`documents_create`	Create an advice document for a client from a document template. Call templates_documents_list first to get a document_template_id.	`client_id` (string, required): Client id the document is for `document_template_id` (string, required): Document template id to base it on	‎
`documents_delete`	Delete a document by id.	`id` (string, required): Document id to delete	Destructive
`documents_export_docx`	Export a document as a DOCX. Requires generated section content. Returns a short-lived signed download URL; fetch promptly (expires in minutes). Does not finalise the document.	`document_id` (string, required): Document id to export as DOCX	Higher rate limit cost
`documents_finalise`	Finalise a document.	`document_id` (string, required): Document id to finalise	‎
`documents_generate`	Start document generation for all sections. Returns immediately; poll documents_get_status until complete.	`document_id` (string, required): Document id `material_ids` (array, required): Attachment or material ids to use as source material (max 50) `mode` (string, required): Generation mode: verbose or concise	Higher rate limit cost
`documents_get`	Get a document by id. Set include_content for section markdown.	`document_id` (string, required): Document id `include_content` (boolean, optional): Include section content as markdown (default false)	Read only
`documents_get_status`	Get the generation status of a document (cheap poll after documents_generate).	`document_id` (string, required): Document id	Read only
`documents_list`	List documents for a client.	`client_id` (string, required): Client id `status` (enum, optional): Optional status filter	Read only
`documents_update_instructions`	Set free-text generation instructions on a document.	`document_id` (string, required): Document id `instructions` (string\|null, required)	‎

Attachments

Tool	Description	Parameters	Notes
`attachments_create`	Create client document attachments from completed file uploads and start text extraction. Not for meeting recordings: use meetings_update_recording for audio or video. Returns immediately; poll attachments_get_status (or attachments_list) until ready or failed.	`client_id` (string\|null, required): Client id when context is client; null for practice context `context` (string, required): Attachment context (usually client) `file_ids` (array, required): File ids from files_complete_upload to attach (max 20)	Higher rate limit cost
`attachments_delete`	Delete an attachment by id.	`id` (string, required): Attachment id to delete	Destructive
`attachments_get`	Get an attachment by id. Set include_content for extracted text.	`id` (string, required): Attachment id `include_content` (boolean, optional): Include extracted text content (default false)	Read only
`attachments_get_status`	Get the processing status of an attachment (cheap poll after attachments_create).	`id` (string, required): Attachment id	Read only
`attachments_list`	List attachments for a client.	`client_id` (string, required): Client id	Read only
`attachments_update`	Update an attachment display name and date.	`id` (string, required): Attachment id `name` (string, required): Display name `date` (string, required): Attachment date as an ISO 8601 timestamp or date	‎

File uploads

Tool	Description	Parameters	Notes
`files_complete_upload`	Finalise an upload after PUT. Verifies the object exists and creates the files row. Pass the resulting id to meetings_update_recording (meeting audio or video) or attachments_create (client documents).	`file_id` (string, required): File id returned from files_request_upload `name` (string, optional)	‎
`files_request_upload`	Mint a short-lived signed upload URL. PUT the file bytes to upload_url, then call files_complete_upload. For meeting audio or video use the resulting file id with meetings_update_recording; for client documents use attachments_create. Do not log the full upload URL.	`type` (string, required) `name` (string, optional): Original filename for the client to keep	‎

Meeting templates

Tool	Description	Parameters	Notes
`templates_meetings_get`	Get a meeting template by id. Set include_outline for outline markdown.	`id` (string, required): Meeting template id `include_outline` (boolean, optional)	Read only
`templates_meetings_list`	List ready meeting templates for this practice. Use an id as template_id for meetings_create.	None	Read only

Document templates

Tool	Description	Parameters	Notes
`templates_documents_get`	Get a document template by id. Sections always include headings; set include_outline for section outline markdown.	`id` (string, required): Document template id `include_outline` (boolean, optional): Include section outlines as markdown (default false)	Read only
`templates_documents_list`	List ready document templates for this practice. Use an id as document_template_id for documents_create.	None	Read only

Common flows

File note from a pasted transcript

clients_list or clients_get to resolve the client.
templates_meetings_list (and optionally templates_meetings_get) for a template id.
meetings_create with client_id and template_id.
meetings_update_transcript with the text.
meetings_submit, then poll meetings_get_status until processed or failed.
Optional meetings_finalise, then meetings_export_file_note_docx for a signed download link.

File note from a recording

Create the meeting as above for a named client.
files_request_upload, upload bytes to the returned URL, files_complete_upload.
meetings_update_recording with the file id (not attachments_create).
meetings_submit and poll meetings_get_status.

Advice document

templates_documents_list for a template id.
documents_create with client_id and template_id.
Optional documents_update_instructions, then documents_generate.
Poll documents_get_status, then documents_finalise and documents_export_docx as needed.

Last updated 30th July 2026 by Tsogt