Kate Docs
Platform

Tool Management

Dashboard documentation for creating, validating, and managing tools.

The tool management pages in the Kate dashboard let sellers create and validate tools, and let buyers manage which tools their agents can use.

Seller: Creating a Tool

Navigate to Artifacts > Create New and select Tool as the artifact type.

Code Editor

Paste your Python function code. The editor provides syntax highlighting and basic error detection.

Requirements:

  • Single entry point function
  • Type hints on all parameters
  • Docstring describing the tool's purpose
  • Maximum 50,000 characters

Entry Point

Enter the name of your function (e.g., get_weather). This must match the function definition in your code.

Description

A short description shown to buyer agents during discovery. Be specific about what the tool does and what inputs it expects.

Manifest Configuration

Secrets - declare any API keys or credentials your tool needs:

  • Key - the environment variable name (e.g., WEATHER_API_KEY)
  • Label - human-readable name shown to buyers
  • Help - instructions for how buyers can get the credential

Network domains - list every external domain your tool connects to (e.g., api.openweathermap.org). Leave empty if your tool doesn't make network calls.

Test Cases

Add at least 2 test cases (up to 20). Each test case specifies:

  • Inputs - JSON object matching your function's parameters
  • Expected output - exact match, or use "contains" to check for specific strings in the output

Validation

Click Validate to run the 6-step validation pipeline. The dashboard shows each step's status in real time:

StepWhat It Checks
SyntaxValid Python code
SecurityNo unsafe patterns
DependenciesAll imports are available
FunctionEntry point exists, type hints present, docstring exists
TestsTest cases pass in isolated environment
OutputResults are JSON-serializable and match expectations

If any step fails, the error message tells you what to fix. You can edit your code and re-validate as many times as needed.

Publishing

Once validation passes, set your pricing (subscription tokens and per-query tokens) and click Publish. The tool becomes discoverable by buyer agents.


Buyer: Managing Tools

Navigate to your agent's page and select the Tools tab.

Tool List

Each tool shows:

FieldDescription
NameThe tool's function name
DescriptionWhat the tool does
Per-query costTokens charged per execution
Status badgeCurrent availability
ToggleEnable or disable the tool

Status Badges

BadgeMeaning
ActiveTool is enabled and ready to use
DisabledYou've turned this tool off
Needs SetupCredentials are required but not yet provided
UnavailableTool is not available (validation failed or seller issue)

Credential Setup

For tools marked Needs Setup, click the tool to see which credentials are missing. You can:

  1. Enter credentials directly in the dashboard (values are encrypted)
  2. Or set them via the API (see Environment Variables API)

Once all required credentials are provided, the tool status updates automatically.

Approval Mode

In your agent's settings, choose how new tools are activated:

  • Auto - tools are enabled automatically when discovered and credentials are complete. Best for agents that need to act independently.
  • Manual - you review and approve each tool before your agent can use it. Best when you want to control which tools your agent accesses.

You can switch modes at any time. When switching from manual to auto, all tools that have passing validation and complete credentials are enabled automatically.

Tool Detail View

Click any tool to see its full details:

  • Function signature and docstring
  • Manifest (required secrets, allowed network domains)
  • Test cases
  • Execution history and token charges
  • Credential status for each required key

Next Steps

On this page