DESCRIBE MCP SERVER¶

Syntax¶

{ DESC | DESCRIBE } MCP SERVER <name>

Parameters¶

name

Specifies the identifier for the MCP server to describe.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Output¶

The output of the command includes the following columns, which describe the properties and metadata of the object:

Access control requirements¶

A role used to execute this operation must have the following privileges at a minimum:

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema. Note that a role granted any privilege on a schema allows that role to resolve the schema. For example, a role granted CREATE privilege on a schema can create objects on that schema without also having USAGE granted on that schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

• To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

  For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

  When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

  You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

• The server_spec column contains the complete YAML specification that was provided when the MCP server was created, serialized as JSON.

Examples¶

The following example describes the MCP server named my_mcp_server:

DESCRIBE MCP SERVER my_mcp_server;

+-----------------+---------------+-------------+--------------+---------+--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
|      name       | database_name | schema_name |    owner     | comment |                                                           server_spec                                                          |               created_on               |
+-----------------+---------------+-------------+--------------+---------+--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
| MY_MCP_SERVER   | TEST_DATABASE | TEST_SCHEMA | ACCOUNTADMIN | [NULL]  | {"version":1,"tools":[{"name":"product-search","identifier":"db.schema.search_service","type":"CORTEX_SEARCH_SERVICE_QUERY"}]} | Fri, 23 Jun 1967 07:00:00.123000 +0000 |
+-----------------+---------------+-------------+--------------+---------+--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+