Skip to main content
POST
Create tool

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

Query Parameters

source_target_kind
string
target_branch_id
string<uuid> | null

Body

application/json
id
string
required

Tool ID, a lowercase slug; it also names the tool source file.

Required string length: 1 - 128
Pattern: ^[a-z0-9][a-z0-9-]*$
description
string | null

Tool description. Null leaves it empty. On update, REST and GraphQL clear an omitted description and the MCP tool keeps the current one.

source
string

Complete TypeScript source of the tool file. When set it is written as-is and description is ignored.

Minimum string length: 1

Response

Created tool document

id
string
required
name
string
required
description
string | null
required
source_path
string
required
source
string
required
edit_mode
enum<string>
required
Available options:
structured,
source_only
source_only_reasons
string[]
required