Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Create a Custom Tool

post
{protocol}://{base-url}/ai/api/v1/config/tool

Create a custom tool. The tool is automatically published to MCP.

Body Params

Request schema for creating a new tool configuration.

The tool_type determines which fields are required:

  • AGENT_AS_TOOL: requires agent_id and function_name
  • SMTP: requires smtp_config and auth (with BASIC auth_type)
  • HTTP: requires http_config, auth_config, and input_parameter_schema

string
required
length ≥ 2

Display name for the tool.

string
required
length ≥ 2

Description of the tool's functionality.

This will be included in agent prompts to help the LLM understand
when and how to use this tool.

string
required
length ≥ 1

The unique name identifying this tool to an LLM.

string
enum
Defaults to llm_judge_scorer

Reference to the Tool Scorer to use when using tool-based evaluation.

Allowed:
string
enum
required

The type of the tool. Cannot be DEFAULT.

Allowed:
boolean
Defaults to false

Whether this tool requires user approval before execution.

When agent_id is present, this is a tool that runs that agent.

SMTPConfig | null

SMTP server configuration for SMTP tools.

object | null

JSON schema describing the tool's input parameters.

Required for non-agent-as-tool types. For HTTP tools, also used to validate
path parameters in the URL template.

HTTPConfigCreate | null

HTTP endpoint configuration for HTTP tools.

AuthConfigCreate | null

Authentication configuration for SMTP and HTTP tools.

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?