Tools

Register a new tool

Authorization: platform admin only. Allowed callers: a Mnemom staff session (JWT or cookie whose role is mnemom_staff), or an API key carrying the admin:platform scope whose owner is re-verified as Mnemom staff on every request. Everyone else gets 403 Admin access required — that includes org owners and org admins of any tenant, ordinary users, and API keys without admin:platform (or whose owner is no longer staff). The BearerAuth / ApiKeyAuth schemes say how the caller authenticates, not who is allowed; the platform-admin check runs before the body is read, so a non-admin never reaches validation. An unauthenticated call gets 401.

Inserts a new tool row. Idempotency-Key is required (400 when absent; 409 while a request with the same key is still in flight, or when the tool name already exists; 422 when the key was already used with a different body). The composer sets content_hash + version=1; subsequent PATCH calls bump version only when content_hash changes.

post/tools

Request

  • Base URL: https://api.mnemom.ai/v1
  • URL: https://api.mnemom.ai/v1/tools
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Mnemom-Api-Key

Headers

Idempotency-Keystring required

Per-mutation idempotency key (RFC draft-ietf-httpapi-idempotency-key-header).

Request body

namestring required

Globally unique tool name. Convention: <connector>_<verb>_<noun> (e.g. campfire_create_chart_account). Org-scoped tools use the reserved org:<id>: prefix.

class'read' | 'internal_write' | 'consequential_internal_write' | 'consequential_external_write' | 'comms_internal' | 'comms_external' | 'engineering_attestation' | 'governance_write' required

8-entry action class taxonomy per mnemom-contracts/tool-manifest/v1.yaml. V7 gateway hooks bind on this for class-scoped enforcement.

domain'financial' | 'engineering' | 'intelligence' | 'growth' | 'operations' | 'governance' | 'comms' | 'identity' | 'security' required

9-entry domain taxonomy. Used by domain-scoped value declarations like policy_attentiveness(domain: financial).

descriptionstring nullable
display_namestring nullable
schemaobject nullable

OpenAPI fragment / JSON Schema for the tool parameters. Populated when the tool is imported via OpenAPI spec.

source_connectorstring nullable

Response

Tool registered.

namestring required

Globally unique tool name. Convention: <connector>_<verb>_<noun> (e.g. campfire_create_chart_account). Org-scoped tools use the reserved org:<id>: prefix.

display_namestring nullable
descriptionstring nullable
class'read' | 'internal_write' | 'consequential_internal_write' | 'consequential_external_write' | 'comms_internal' | 'comms_external' | 'engineering_attestation' | 'governance_write' required

8-entry action class taxonomy per mnemom-contracts/tool-manifest/v1.yaml. V7 gateway hooks bind on this for class-scoped enforcement.

domain'financial' | 'engineering' | 'intelligence' | 'growth' | 'operations' | 'governance' | 'comms' | 'identity' | 'security' required

9-entry domain taxonomy. Used by domain-scoped value declarations like policy_attentiveness(domain: financial).

schemaobject nullable

OpenAPI fragment / JSON Schema for the tool parameters. Populated when the tool is imported via OpenAPI spec.

source_connectorstring nullable
deprecated_atstring date-time nullable
content_hashstring nullable
versioninteger required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.