tools

Creates, updates, deletes, gets or lists a tools resource.

Overview

Name	tools
Type	Resource
Id	confluent.sql.tools

Fields

The following fields are returned by SELECT queries:

get_sqlv1_tool

Tool.

Name	Datatype	Description
name	string	The user provided name of the tool, unique within this environment. (example: linear-mcp-tool, pattern: [a-z0-9_]([-a-z0-9_]*[a-z0-9_])?)
api_version	string	APIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
kind	string	Kind defines the object this REST resource represents. (Tool)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The spec of the Tool. A tool must reference either a connection (for MCP or A2A tools) or a function (for function-based tools), but not both.
status	object	The status of the Tool

list_sqlv1_tools

Tools.

Name	Datatype	Description
name	string	The user provided name of the tool, unique within this environment. (example: linear-mcp-tool, pattern: [a-z0-9_]([-a-z0-9_]*[a-z0-9_])?)
api_version	string	APIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
kind	string	Kind defines the object this REST resource represents. (Tool)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The spec of the Tool. A tool must reference either a connection (for MCP or A2A tools) or a function (for function-based tools), but not both.
status	object	The status of the Tool

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sqlv1_tool	select	organization_id, environment_id, database_name, tool_name		Make a request to read a Tool.
list_sqlv1_tools	select	organization_id, environment_id, database_name	page_size, page_token	Retrieve a sorted, filtered, paginated list of all Tools.
create_sqlv1_tool	insert	organization_id, environment_id, database_name, name, spec		Make a request to create a Tool.
delete_sqlv1_tool	delete	organization_id, environment_id, database_name, tool_name		Make a request to delete a Tool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	The name of the database.
environment_id	string	The unique identifier for the environment.
organization_id	string (uuid)	The unique identifier for the organization.
tool_name	string	The user provided name of the Tool.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_sqlv1_tool

Make a request to read a Tool.

SELECT
name,
api_version,
kind,
metadata,
spec,
status
FROM confluent.sql.tools
WHERE organization_id = '{{ organization_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND database_name = '{{ database_name }}' -- required
AND tool_name = '{{ tool_name }}' -- required
;

list_sqlv1_tools

Retrieve a sorted, filtered, paginated list of all Tools.

SELECT
name,
api_version,
kind,
metadata,
spec,
status
FROM confluent.sql.tools
WHERE organization_id = '{{ organization_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND database_name = '{{ database_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_sqlv1_tool

Make a request to create a Tool.

INSERT INTO confluent.sql.tools (
name,
spec,
organization_id,
environment_id,
database_name
)
SELECT 
'{{ name }}' /* required */,
'{{ spec }}' /* required */,
'{{ organization_id }}',
'{{ environment_id }}',
'{{ database_name }}'
RETURNING
name,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: tools
props:
  - name: organization_id
    value: "{{ organization_id }}"
    description: Required parameter for the tools resource.
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the tools resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the tools resource.
  - name: name
    value: "{{ name }}"
    description: |
      The user provided name of the tool, unique within this environment.
  - name: spec
    description: |
      The spec of the Tool. A tool must reference either a `connection` (for MCP or A2A tools)
      or a `function` (for function-based tools), but not both.
    value:
      connection: "{{ connection }}"
      function: "{{ function }}"
      comment: "{{ comment }}"
      options: "{{ options }}"

DELETE examples

delete_sqlv1_tool

Make a request to delete a Tool.

DELETE FROM confluent.sql.tools
WHERE organization_id = '{{ organization_id }}' --required
AND environment_id = '{{ environment_id }}' --required
AND database_name = '{{ database_name }}' --required
AND tool_name = '{{ tool_name }}' --required
;