Agentic Platform
Documentation API reference Tools Skills

Tools

Tables Schema

tables_schema MCP

Agent that retrieves the schema (field names and types) for a given table

List all fields from a given table, including enum values when known.

Playground

Your organization, project and token stay in this browser's local storage and are sent straight to the API — this page never sees them.

POST
item
table_name required Name of the table to get schema for. Wildcard not allowed.

Billing

Fixed cost per item requested. Reading a table's schema is a metadata lookup and scans none of its data.

These usage SKUs can be charged on a call.

SKU Credits Description
Tool call 1 per request Charged once per successful item.

Schemas

item is what you send, config how the tool behaves, and the response is what you get back.

Item

object
Properties
table_name string required

Name of the table to get schema for. Wildcard not allowed.

Example
{
  "table_name": "string"
}

Response

object
Properties
table_name string required

Name of the table

fields array required

List of field definitions with name, type, and enum values when known

Items: TableField

found boolean required

Whether the table was found in the available tables

Example
{
  "table_name": "string",
  "fields": [
    {
      "name": "string",
      "type": "string",
      "mode": "string",
      "fields": null,
      "description": null,
      "enum": null,
      "bitmask": null
    }
  ],
  "found": true
}

Type Definitions

2 types

These are the available sub-object types that can be used in the properties above.

TableField object
#
name string required
type string required
mode string required
fields TableField

Items: TableField

Default: null

description string | null

Optional documentation for this field

Default: null

enum TableFieldEnumValue

Known discrete values for this field. Each entry has value, name, and optional extra. Absent when the field is not an enum.

Items: TableFieldEnumValue

Default: null

bitmask boolean | null

If true, enum values are combinable flags. Test a nonzero flag with `column & value != 0`; for a zero/no-flags value, use `column = 0`.

Default: null

TableFieldEnumValue object
#

One known discrete value of a table field (regular enum or bitmask flag).

value integer | string required
name string required
extra string | null

Default: null

Endpoints

POST http://agents.botify.com/{organization}/{project}/tables_schema/process
POST http://agents.botify.com/{organization}/{project}/tables_schema/batch_process
POST http://agents.botify.com/{organization}/{project}/tables_schema/async_process
POST http://agents.botify.com/{organization}/{project}/tables_schema/async_batch_process

See running a long job in the background for the polling flow.

cURL

curl -X POST "http://agents.botify.com/{organization}/{project}/tables_schema/process" \
  -H "Authorization: Bearer $BOTIFY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "item": {
    "table_name": "<table_name>"
  }
}'

Over MCP

This tool is exposed as the MCP tool tables_schema. An MCP client passes organization, project and item as tool arguments. Set up MCP →

Raw metadata