Tools

The server exposes twelve generic tools in three groups. Each one takes the resource as an argument, so the same tools cover every collection of the REST API.

tools/list answers without a credential, so a client can show the tools before the user connects. Every tools/call needs one (see Connect a client).

Calling a toolCopy Anchor Link

{
  "jsonrpc": "2.0",
  "id": 7,
  "method": "tools/call",
  "params": {
    "name": "get_record",
    "arguments": { "resource": "clients", "id": "hsbftmp3f5" }
  }
}

{
  "jsonrpc": "2.0",
  "id": 7,
  "result": {
    "isError": false,
    "content": [{ "type": "text", "text": "{\n  \"data\": {\n    \"id\": \"hsbftmp3f5\", ..." }],
    "structuredContent": {
      "data": { "id": "hsbftmp3f5", "name": "Acme Studio", "status": "active" }
    }
  }
}

The result carries the API's response body twice: as structuredContent for clients that parse it, and as a JSON text block for clients that do not.

Errors are tool results, not protocol errors. When the API refuses a call (validation, missing scope, not found…), the result has isError: true and the API's error envelope as its content, so the model can read the message and correct itself. A missing required argument is reported the same way, naming the argument. Only an unknown tool name or a malformed request is a JSON-RPC error.

Arguments declared as objects (data, input, filters) may also be sent as a string holding a JSON object; some clients serialize nested objects that way. Anything that is not a JSON object is refused with a message naming the argument.

Each tool declares behavior hints (readOnlyHint, destructiveHint, idempotentHint) so your client can decide what to confirm with the user and what it may retry.

DiscoveryCopy Anchor Link

list_resourcesCopy Anchor Link

Lists every resource the API exposes and, for each, the HTTP methods it accepts, its fields, filters, sorts, relations and required scopes. The map of the territory: call it first, or read the dashly://catalog resource, which holds the same thing.

Arguments: none.

describe_resourceCopy Anchor Link

Describes one resource: readable fields, writable fields, accepted filters, available sorts, relations, required scopes, and the names of its actions. Call it before writing so you are not guessing field names.

An unknown name returns an error listing the available resources.

list_fieldsCopy Anchor Link

The field registry for an entity: the built-in fields plus the agency's own custom fields, with their key, type and options. This is what tells you how to fill customFields.

get_accountCopy Anchor Link

Which agency the credential belongs to, its scopes, and how much of the monthly token allowance is left. Read it when a call comes back 403 (usually a scope the key was not given) or before a long run.

Arguments: none.

RecordsCopy Anchor Link

list_recordsCopy Anchor Link

Lists a resource's records, paginated, with optional search, filters and sort. An undeclared filter or sort comes back as an error naming the accepted ones.

{ "resource": "tickets", "filters": { "clientId": "hsbftmp3f5" }, "sort": "createdAt", "direction": "desc" }

get_recordCopy Anchor Link

Reads one record by its public id. An internal UUID is never a valid address, and a record from another agency answers 404 rather than 403.

create_recordCopy Anchor Link

Creates a record.

• Links (clientId, projectId, stageId, assigneeId…) take the target's public id.
• customFields takes the agency's custom fields by their key (see list_fields). A field that does not exist yet is created through the field-definitions resource.
• For an import, data.createdAt (ISO 8601, in the past) records the record at the date it actually happened. list_resources says which resources accept it.

{ "resource": "tickets", "data": { "title": "Update the pricing page", "clientId": "hsbftmp3f5", "priority": "high" } }

update_recordCopy Anchor Link

Updates a record. Only the fields present in data change, which is also how you move something: a deal changes stage with { "stageId": "…" }, a ticket changes status with { "status": "…" }. Read dashly://conventions first to use a status or stage that exists in this agency.

delete_recordCopy Anchor Link

Deletes a record. Irreversible; where a resource offers archiving, that is the reversible answer. Not every resource allows deletion: describe_resource lists DELETE among its methods only when it does.

ActionsCopy Anchor Link

Much of the product is not a field edit: converting a lead, merging two deals, duplicating a project, freezing a deck, inviting someone, importing a CSV. These are actions. An item action targets one record; a collection action targets the resource as a whole.

list_actionsCopy Anchor Link

Lists the actions (verbs) available beyond create, read, update and delete.

Without a resource, each entry gives resource, action, target (item or collection), readOnly, summary and description. Call it once with no argument to see what the product can do, then with a resource for the exact body of the one you pick.

run_actionCopy Anchor Link

Runs an action returned by list_actions.

The id is resolved inside your agency before the action runs, so an id from another agency is a 404. An action can change a lot (archive, merge, convert), so clients should confirm before calling it and must not retry it blindly. Actions that accept an idempotency key document it in their schema; see Idempotency.

{ "resource": "leads", "action": "convert", "id": "k3n8q2w7xa", "input": { "dealName": "Acme redesign" } }

read_actionCopy Anchor Link

Runs a read action, one that list_actions marks readOnly: computed figures that no single record holds. Examples: the agency's dashboard overview (agency-settings, overview), the calling member's day (members, my-day), a client's site statistics (clients, site-statistics) or its AI visibility (clients, ai-visibility). It changes nothing; the API refuses any action that is not a read.

{ "resource": "clients", "action": "site-statistics", "id": "hsbftmp3f5" }

TimeoutsCopy Anchor Link

Each tool call makes one or more API calls; any single API call that takes longer than 20 seconds is abandoned and reported as a tool error.