oceanbase-mcp: Skill for OpenCode

Purpose

Use this skill when a user asks to inspect OceanBase schemas, understand tables, write read-only SQL, query data, explain results, analyze a query plan, generate ER diagrams, review metadata changes, or produce data documentation.

Workflow

1. Search metadata before writing SQL.
2. Read table context, schema map, or onboarding documentation before choosing columns or joins.
3. Prepare or build only read-only SQL with explicit columns.
4. Lint or preview policy and plan risk before execution.
5. Query with a session and pagination when inspecting data.
6. Summarize rows, filters, page state, warnings, and next steps.

Metadata First

Use these tools before SQL:

• ob_search_everything for business terms, table names, column names, comments, and glossary hits.
• ob_search_business_glossary for configured business-term mappings. Treat results as hints and verify with metadata tools.
• ob_get_schema_map, ob_find_tables_by_business_term, and ob_find_columns to narrow candidate tables and fields.
• ob_get_table_context, ob_get_table_summary, or ob_generate_onboarding_doc for table structure, relationships, query entry points, and glossary hints.
• Existing metadata tools as fallback: ob_get_table_ddl, ob_describe_table, ob_get_indexes, ob_get_constraints, ob_get_partitions, ob_get_table_stats, ob_find_related_tables, and ob_generate_query.

Never invent table names, fields, joins, or relationships. If metadata is insufficient, ask for the business term, schema, or table name.

Query Rules

• Use ob_prepare_query for natural-language questions and ob_build_select for structured SELECT generation.
• Use ob_lint_sql or ob_query_preview before executing a user-facing query.
• Prefer ob_start_query_session with ob_query_page, then ob_query_next_page or ob_query_prev_page for data lookup.
• Use ob_query only with explicit selected columns, filters, ordering, and a small limit.
• Use ob_profile_table, ob_profile_columns, ob_get_value_distribution, ob_detect_time_columns, and ob_detect_dimension_columns for data understanding.
• Use ob_policy_explain when checking whether SQL is allowed.
• Use ob_analyze_query_plan or ob_generate_performance_report for performance questions.