Every tool the MCP server exposes, grouped by area.
You don't call these tools yourself — your AI assistant picks them based on what you ask. This page shows
what is possible and which rules apply. Your client receives the full parameter schemas automatically
through tools/list.
All tools work within your company and with your role. Write tools apply
the same validation as the admin panel, so anything locked in the panel (for example a model connected to
an endpoint, or settings of a deployed version) is locked here too.
Models
Tool
Parameters
Description
listModels
—
Lists all models of the company.
getModel
id
Returns a model with its fields. editable is false once the model is connected
to an endpoint.
createModel
name, fields, isSelfReferencing (optional)
Creates a model with the given fields (see field properties). Set
isSelfReferencing for tree data such as categories with subcategories. A related model
must exist before it can be referenced.
updateModel
id, name, fields, isSelfReferencing (optional)
Renames a model and adds or updates fields. Fields left out are not removed. Fails if
the model is connected to an endpoint.
deleteModelField
fieldId
Deletes one field. Not allowed on the primary key, system fields, or models connected to an endpoint.
updateFieldRequired
fieldId, required
Changes whether a field is required. Unlike updateModel, also works on models connected to
an endpoint.
Field properties
Each item in fields accepts the following properties. name and type
are required.
Property
Description
id
updateModel only — an existing field's id to update it. Omit to add a new field.
name
Lowercase letters, digits and _; unique within the model.
type
keyword, text, integer, long, float,
boolean, date, object or nested.
format
Required for date: date (yyyy-MM-dd) or date_time (ISO 8601).
primaryKey
Exactly one field per model; must be integer or keyword.
required
Whether the field must have a value. Always true for the primary key.
isSearchable
Include the field in full-text search.
isVisibleInRelatedModel
Include the field when this model is embedded in another model through a relation.
exampleValue
Example shown in the generated API documentation.
relatedModelId
Makes the field a relation to another model. Use type object for a single related item,
nested for a list.
Company
Tool
Parameters
Description
getCompanyInfo
—
Returns company name, phone and subdomain. Requires manager access.
setCompanySubdomain
subdomain
Sets the company subdomain. This can only be done once and can never be changed
afterwards.
updateCompanyInfo
companyName (optional), phone (optional)
Updates the company name and/or phone. Requires the subdomain to be set.
APIs & Versions
Tool
Parameters
Description
listApis
—
Lists the company's APIs.
getApi
id
Returns an API with its versions.
getApiDeployProgress
apiId
Shows whether each version is published and the progress of background data copying after a deploy.
createApi
name, path
Creates an API with an initial undeployed version v1. Requires the subdomain to be set.
updateApi
id, name, path
Renames an API or changes its path. Fails once any of its versions is deployed.
createApiVersion
apiId
Creates the next version (e.g. v2), copying endpoints, settings and API key access from the
previous one. The previous version must be deployed.
deployApiVersion
apiVersionId
Deploys a version and makes it live. Every endpoint needs at least one API key. Also used to redeploy
after changing endpoint methods. Cannot be undone.
Endpoints
An endpoint group connects one model to one API version. Tools identify a group by its
modelId and apiVersionId.
Tool
Parameters
Description
listEndpoints
apiVersionId
Lists the endpoints of a version with their method, path and model.
getEndpointDetails
modelId, apiVersionId
Shows current aggregation and boost settings and which fields are eligible for them.
createEndpoint
apiId, apiVersionId, modelId, path, methods
Creates endpoints for a model with the given HTTP methods (e.g. ["GET", "POST"]). Endpoints
for related models are created automatically. New endpoints have no API key yet.
Changes description, page size or the model. Only before the group is deployed.
updateEndpointMethods
modelId, apiVersionId, methods
Replaces the enabled HTTP methods. Removing a method deletes its endpoints and their settings. On a
deployed version, redeploy for the change to take effect.
updateEndpointAggregation
modelId, apiVersionId, fields
Sets the aggregation (facet) fields of the list endpoint. Only before the version is deployed.
updateFieldBoosts
modelId, apiVersionId, boosts
Sets search relevance weights per field. Also works on a deployed version and takes effect immediately.
API Keys
Tool
Parameters
Description
listApiKeys
—
Lists the company's API keys.
getApiKeyPermissions
apiKeyId
Lists the endpoints a key can access.
createApiKey
name
Creates an API key with no access. Grant access with one of the tools below.
assignApiKeyToEntireApi
apiKeyId, apiId
Gives a key access to every current endpoint of an API, replacing its previous access to that API.
Endpoints added later are not included.
grantApiKeyEndpoints
apiKeyId, endpoindVersionIds
Adds access to specific endpoints, keeping existing access.
revokeApiKeyEndpoints
apiKeyId, endpoindVersionIds
Removes access to specific endpoints, keeping everything else.
Team Members
All team member tools require manager access. A manager can only manage regular users and
their own account; other managers can only be managed by the company owner. Assigning the Manager role,
changing passwords and reactivating members are only available in the dashboard, not through MCP.
Tool
Parameters
Description
listTeamMembers
—
Lists team members with their role and active state.
addTeamMember
email, name, surname, password
Adds a member with the User role and sends an email verification link. Managers can
only be created or promoted in the dashboard.
updateTeamMember
id, name, surname, email
Updates a member's name, surname and email. Role and password can only be changed in the dashboard.
Not allowed on the company owner, or on other managers unless you are the owner.
deactivateTeamMember
id
Blocks login and MCP access immediately. Not allowed on your own account, the company owner, or other
managers unless you are the owner. Reactivation is only available in the dashboard.
Utility
Tool
Parameters
Description
ping
—
Returns pong. Useful to check that the connection works.
Example Prompts
A single request can trigger several tools in a row:
You ask
Tools the assistant uses
"Create a products model with id, name and price, publish it under a new catalog API with GET and
POST, and create a key for my mobile app."