// MCP TOOL REFERENCE

MCP OCEANBASE TOOLS

134 tools from the Mcp Oceanbase MCP Server, categorised by risk level.

View the Mcp Oceanbase policy →
// ALL 134 MCP OCEANBASE TOOLS
READ 77 tools
Read ai_rerank ai_rerank Read diagnostics Diagnose the operational status of a tenant Read full_text_search full_text_search Read get_ai_model_endpoints Get all registered AI model endpoints from seekdb. Returns: str: JSON string containing the li... Read get_all_obshell_sdk_methods 获取 obshell 所有可供用户使用的 sdk 方法 只有当其他的 tool 不适用时，才通过该方法获取所有 sdk 方法。 Read get_all_oceanbase_tenants get_all_oceanbase_tenants Read get_all_server_nodes Get all server nodes from oceanbase. You need to be sys tenant to get all server nodes. Read get_current_tenant Get the current tenant name from oceanbase. Read get_current_time Get current time from seekdb database. Read get_memory_by_id Get specific memory Args: memory_id: Memory ID user_id: User identifier agent_... Read get_ob_ash_report Get OceanBase Active Session History report. ASH can sample the status of all Active Sessions in the sy... Read get_obshell_sdk_methods_description 获取 obshell 的 sdk 方法的描述 Read get_oceanbase_alarm_detail Query alarm event detail This interface is used to query detailed information of a specified alarm eve... Read get_oceanbase_alarms get_oceanbase_alarms Read get_oceanbase_cluster_parameters Get OceanBase cluster parameters list This interface is used to get the parameter list of the target O... Read get_oceanbase_cluster_server_stats Get resource statistics for all OBServers in the cluster This interface is used to get resource statis... Read get_oceanbase_cluster_servers Get OceanBase cluster OBServer list This interface is used to query all OBServer node information of t... Read get_oceanbase_cluster_snapshots Query cluster snapshot information Query snapshot information of a specified cluster. The caller m... Read get_oceanbase_cluster_stats Get OceanBase cluster resource statistics This interface is used to get resource statistics informatio... Read get_oceanbase_cluster_tenants get_oceanbase_cluster_tenants Read get_oceanbase_cluster_units Query OceanBase cluster Unit list This interface is used to query the Unit list of an OceanBase cluste... Read get_oceanbase_cluster_zones Get OceanBase cluster Zone list This interface is used to query the Zone list of an OceanBase cluster.... Read get_oceanbase_inspection_item_last_result Query the last inspection result of a specified inspection item This interface queries the last inspec... Read get_oceanbase_inspection_overview get_oceanbase_inspection_overview Read get_oceanbase_inspection_report Get inspection report detail This interface is used to get inspection report detail. The caller mu... Read get_oceanbase_inspection_report_info Get the last inspection result of a specific object This interface queries the last inspection result ... Read get_oceanbase_inspection_tasks get_oceanbase_inspection_tasks Read get_oceanbase_metric_data_with_label get_oceanbase_metric_data_with_label Read get_oceanbase_metric_groups Query monitor metric description information This interface is used to query the description informati... Read get_oceanbase_obproxy_cluster_detail Query OBProxy cluster detail This interface is used to query OBProxy cluster detail information. T... Read get_oceanbase_obproxy_cluster_parameters Query OBProxy cluster parameters This interface is used to query OBProxy cluster parameter settings. ... Read get_oceanbase_performance_report Query performance report Query cluster performance report. The caller must have read and write per... Read get_oceanbase_sql_text get_oceanbase_sql_text Read get_oceanbase_tenant_databases Get database list This interface is used to get the database list of a tenant. The caller must be ... Read get_oceanbase_tenant_detail Query tenant detail This interface is used to query details of a specified tenant. The caller must... Read get_oceanbase_tenant_objects Get database object list This interface is used to get the database object list of a tenant. The c... Read get_oceanbase_tenant_parameters Get tenant parameters list This interface is used to get the parameter list of a tenant. The calle... Read get_oceanbase_tenant_role_detail Get database role detail This interface is used to get the detail of a database role. The caller m... Read get_oceanbase_tenant_roles Get database role list This interface is used to get the database role list of a tenant. The calle... Read get_oceanbase_tenant_slow_sql Query slow SQL list This interface is used to query slow SQL list. The caller must have read permi... Read get_oceanbase_tenant_top_sql get_oceanbase_tenant_top_sql Read get_oceanbase_tenant_units Query tenant Unit list This interface is used to query the Unit list of a tenant. The caller must ... Read get_oceanbase_tenant_user_detail Get database user detail This interface is used to get the detail of a database user. The caller m... Read get_oceanbase_tenant_users Get database user list This interface is used to get the database user list of a tenant. The calle... Read get_oceanbase_zone_servers Get Zone OBServer list This interface is used to query OBServer node information under the specified Z... Read get_registered_ai_models get_registered_ai_models Read get_resource_capacity Get resource capacity from oceanbase. You need to be sys tenant to get resource capacity. Read get_user_profile Get user profile information by user_id Retrieves the complete user profile including both non-structu... Read has_collection has_collection Read hybrid_search hybrid_search Read list_all_clusters 列出所有的OceanBase集群 Read list_backup_policies list_backup_policies Read list_collections list_collections Read list_databases describe databases by teant id Read list_instances list oceanbase instances Read list_memories List all memories Args: user_id: User identifier agent_id: Agent identifier ru... Read list_obproxy_clusters Query OBProxy cluster list This interface is used to query OBProxy cluster list information. The c... Read list_oceanbase_clusters list_oceanbase_clusters Read list_tenants describe tenants by instance id Read list_user_profiles list_user_profiles Read obdiag_analyze_log 分析集群日志，找出发生过的错误信息并返回 :param cluster_name: 集群配置文件名前缀，可选。如 ob_test 表示使用 ~/.obdiag/ob_test.yml。不传则使用默认 con... Read obdiag_cluster_list 列出可用的集群配置名称列表，用于在其他工具中指定 cluster_name 参数 返回 ~/.obdiag/ 目录下所有 .yml 配置文件的文件名前缀（不含 .yml），已排除 ai.yml 例如... Read obdiag_display_list obdiag 集群信息查询功能，返回支持的指令列表 :param cluster_name: 集群配置文件名前缀，可选。如 ob_test 表示使用 ~/.obdiag/ob_test.yml。不传则使用默... Read obdiag_gather_log obdiag_gather_log Read oceanbase_hybrid_search Perform hybird search combining relational condition filtering(that is, scalar) and vector search. Arg... Read oceanbase_text_search Search for documents using full text search in an OceanBase table. Args: table_name: Name of t... Read oceanbase_vector_search Perform vector similarity search on an OceanBase table. Args: table_name: Name of the table to... Read peek_collection peek_collection Read query query infos from tenant Read query_collection query_collection Read search_memories Search memories Args: query: Search query text user_id: User identifier agent_... Read search_memories_with_profile Search memories and optionally include user profile information This tool searches for relevant memori... Read search_oceanbase_document search_oceanbase_document Read seekdb_memory_query seekdb_memory_query Read show_backup_policy show_backup_policy Read show_cluster show_cluster Read show_tenant show_tenant
WRITE 27 tools
Write change_tenant_password change_tenant_password Write add_data_to_collection add_data_to_collection Write add_memory add_memory Write add_memory_with_profile add_memory_with_profile Write ai_complete ai_complete Write configure_cluster_connection 配置集群查询相关的连接 Args: cluster_name: 集群名称 tenant_name: 租户名称，默认为sys namespace: 命名空间，... Write connect create connection to oceanbase database Write create_ai_model create_ai_model Write create_ai_model_endpoint create_ai_model_endpoint Write create_backup_policy create_backup_policy Write create_cluster create_cluster Write create_collection Create a new collection in seekdb. A collection is similar to a table in a database, used for storing ... Write create_oceanbase_performance_report Generate performance report Generate cluster performance report. The caller must have read and wri... Write create_tenant create_tenant Write export_csv_file_from_seekdb Export data from seekdb to a CSV file. Args: name: The name of the table or collection to expo... Write import_csv_file_to_seekdb Import a CSV file to seekdb. Args: filePath: The path to the CSV file. The file must have a he... Write resume_backup_policy resume_backup_policy Write seekdb_memory_insert seekdb_memory_insert Write seekdb_memory_update seekdb_memory_update Write set_oceanbase_cluster_parameters Update OceanBase cluster parameters This interface is used to update parameters of the target OceanBas... Write set_oceanbase_tenant_parameters Update tenant parameters This interface is used to update parameters of a tenant. The caller must ... Write setup_environment setup_environment Write update_backup_policy update_backup_policy Write update_cluster update_cluster Write update_collection update_collection Write update_memory Update memory Args: memory_id: Memory ID content: New content user_id: User id... Write update_tenant update_tenant
DESTRUCTIVE 12 tools
Destructive delete_all_memories Batch delete memories Args: user_id: User identifier agent_id: Agent identifier ... Destructive delete_backup_policy delete_backup_policy Destructive delete_cluster 删除指定命名空间中的OceanBase集群 Args: cluster_name: 要删除的集群名称 namespace: 要从中删除集群的命名空间 Destructive delete_collection Delete a collection from seekdb. This will permanently delete the collection and all its data. This op... Destructive delete_documents delete_documents Destructive delete_memory Delete memory Args: memory_id: Memory ID user_id: User identifier agent_id: Ag... Destructive delete_memory_with_profile Delete memory and optionally the associated user profile Args: memory_id: Memory ID to delete ... Destructive delete_tenant delete_tenant Destructive delete_user_profile Delete user profile by user_id Removes the user profile from storage. This does not delete the user's ... Destructive drop_ai_model drop_ai_model Destructive drop_ai_model_endpoint drop_ai_model_endpoint Destructive seekdb_memory_delete seekdb_memory_delete
EXECUTE 18 tools
Execute execute_cluster_sql 在集群指定租户下执行SQL查询，支持各种常见SQL查询语句，如SELECT、SHOW TABLES、SHOW COLUMNS等 Args: query: SQL查询语句 c... Execute execute_sql Execute an SQL on the OceanBase server. Execute obdiag_display_run obdiag 集群信息查询功能，执行获取的指令列表，需要功能来自obdiag_display_list的返回结果。只需要返回obdiag_display_list结果 :param scene: 指令名，来... Execute run_oceanbase_inspection Run inspection This interface is used to initiate inspection for specified objects with a specific sce... Execute scale_cluster scale_cluster Execute scale_tenant scale_tenant Execute call_obshell_sdk call_obshell_sdk Execute obdiag_check_run 巡检集群，并返回巡检报告 :param cluster_name: 集群配置文件名前缀，可选。如 ob_test 表示使用 ~/.obdiag/ob_test.yml。不传则使用默认 config.yml ... Execute pause_backup_policy pause_backup_policy Execute replay_tenant_log replay_tenant_log Execute switchover_tenant switchover_tenant Execute upgrade_cluster upgrade_cluster Execute upgrade_tenant upgrade_tenant Execute activate_tenant activate_tenant Execute install_component 安装OceanBase组件, 目前支持ob-operator，ob-dashboard, local-path-provisioner,cert-manager,不支持其他组件， 如果未指定，默认将安装ob... Execute install_ob_operator 安装ob-operator Execute install_okctl 安装okctl Execute update_component 更新OceanBase组件, 目前支持ob-operator，ob-dashboard, local-path-provisioner,cert-manager,不支持其他组件， 如果未指定，默认将更新ob...

Route Mcp Oceanbase through PolicyLayer and every one of its 134 tools is checked against your policy before it runs.

GOVERN MCP OCEANBASE →

Enforced before the call runs. Nothing to install.

// FAQ
How many tools does the Mcp Oceanbase MCP server have? +

The Mcp Oceanbase MCP server exposes 134 tools across 4 categories: Read, Write, Destructive, Execute.

How do I enforce policies on Mcp Oceanbase tools? +

Route the Mcp Oceanbase server through the PolicyLayer gateway. Define allow, deny, or approval rules per tool in the dashboard; they are enforced on every call before it reaches the server.

What risk categories do Mcp Oceanbase tools fall into? +

Mcp Oceanbase tools are categorised as Read (77), Write (27), Destructive (12), Execute (18). Each category has a recommended default policy.

Enforce policy on every Mcp Oceanbase tool call.

Deterministic rules across all 134 Mcp Oceanbase tools. Per-identity grants. Full audit log. Live in minutes. Nothing to install.

GOVERN MCP OCEANBASE →

Free to start. No card required.

42,500+ MCP servers and 110,000+ tools scanned and risk-classified.

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.