create-mcp-toolset-custom-sql-tool

Description

Creates a new Database Tools MCP Toolset for a custom SQL tool.

Usage

oci dbtools mcp-toolset create-mcp-toolset-custom-sql-tool [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment containing the Database Tools MCP server.

--display-name [text]

A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

--mcp-server-id [text]

The OCID of the Database Tools MCP Server

--source [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--tool-name [text]

Name of the tool returned by the MCP Server

--toolset-version [integer]

The MCP toolset version

Optional Parameters

--allowed-roles [complex type]

The roles granted access to the MCP tool generated by this toolset This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--default-execution-type [text]

The default execution type for the toolset. The default value is SYNCHRONOUS.

To use ASYNCHRONOUS execution, the MCP Server must have the storage property configured.

Accepted values are:

ASYNCHRONOUS, SYNCHRONOUS
--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--description [text]

A human readable description of the Database Tools MCP toolset.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--locks [complex type]

Locks associated with this resource.

This option is a JSON list with items of type ResourceLock. For documentation on ResourceLock please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/databasetools/20201005/datatypes/ResourceLock. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--tool-description [text]

Instructions describing how to use the MCP toolset and its features. This can be used to improve the LLM’s understanding of the tool.

--variables [complex type]

The variables to use with the query

This option is a JSON list with items of type DatabaseToolsMcpToolsetCustomSqlToolVariable. For documentation on DatabaseToolsMcpToolsetCustomSqlToolVariable please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/databasetools/20201005/datatypes/DatabaseToolsMcpToolsetCustomSqlToolVariable. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state ACCEPTED --wait-for-state NEEDS_ATTENTION would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci dbtools mcp-toolset create-mcp-toolset-custom-sql-tool --generate-param-json-input source > source.json

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/mcp-toolset/create-mcp-toolset-custom-sql-tool.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/mcp-toolset/create-mcp-toolset-custom-sql-tool.html#cmdoption-display-name
    export mcp_server_id=<substitute-value-of-mcp_server_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/mcp-toolset/create-mcp-toolset-custom-sql-tool.html#cmdoption-mcp-server-id
    export tool_name=<substitute-value-of-tool_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/mcp-toolset/create-mcp-toolset-custom-sql-tool.html#cmdoption-tool-name
    export toolset_version=<substitute-value-of-toolset_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/mcp-toolset/create-mcp-toolset-custom-sql-tool.html#cmdoption-toolset-version

    oci dbtools mcp-toolset create-mcp-toolset-custom-sql-tool --compartment-id $compartment_id --display-name $display_name --mcp-server-id $mcp_server_id --source file://source.json --tool-name $tool_name --toolset-version $toolset_version