Kitemesh Documentation

English

Francais

English

Francais

Appearance

Tools ​

What tools are for ​

Tools allow Kitemesh to run HTTP calls against external apps or APIs. They are useful for connecting a CRM, a ticketing system, a business API, or another HTTP action.

Tools are meant for actions. For read-only GET lookups, use API Resources.

What a tool includes ​

A tool is usually configured with:

  • a name
  • a description
  • an HTTP method
  • a URL
  • an argument schema
  • authentication fields
  • tags
  • a user approval requirement

Supported methods are POST, PATCH, PUT, and DELETE.

Create a tool ​

  1. Open Configuration.
  2. Select the Tools tab.
  3. Click Create Tool.
  4. Fill in Name, Description, HTTP Method, and URL Template.
  5. Add an Arguments Schema (JSON).
  6. Select vault secrets in Authentication when the target API needs credentials.
  7. Choose Shared with scopes.
  8. Keep Require user validation enabled for sensitive actions.
  9. Save the tool.

After saving, the tool appears in the list and can be used by chats that match its sharing scope.

Authentication ​

Tools can reuse secrets stored in the Vault. This is the right choice for:

  • API keys
  • bearer tokens
  • sensitive custom headers

Secrets should not be hard-coded directly into a tool configuration.

Argument schema ​

The argument schema describes the parameters expected by the tool. The clearer the schema is, the more reliably the assistant can use the tool.

A good schema:

  • names fields clearly
  • distinguishes required fields
  • reduces ambiguity
  • matches the structure expected by the target API

User approval ​

When user approval is enabled, the assistant asks for confirmation before the tool runs. This setting is especially useful for:

  • irreversible actions
  • operations that write into external systems
  • sensitive or high-impact calls

If approval is disabled, the tool can run without a manual confirmation step when the assistant decides it is needed.

Configuration tips ​

  • Start with one simple and easy-to-test tool.
  • Use tool names that describe the action clearly.
  • Attach the tool to the right sharing scope.
  • Add tags when several similar tools coexist.

When to create several tools ​

Separate tools are usually the better choice when:

  • actions have different risk levels
  • expected parameters differ significantly
  • secrets or access rules are not the same
  • business use cases are clearly distinct