Relational Database Mcp Cloudbase logo

Relational Database Mcp Cloudbase

OrganizationPopular
TencentCloudBase
relational-database-mcp-cloudbase

[Deprecated] This is the required documentation for agents operating on the CloudBase Relational Database through MCP. It defines the canonical SQL management flow with `queryMysqlDatabase`, `manageMysqlDatabase`, `queryPermissions`, and `managePermissions`, including MySQL provisioning, destroy flow, async status checks, safe query execution, schema initialization, and permission updates. New environments should use PostgreSQL — see postgresql-development skill instead.

Overview

PublisherTencentCloudBase
RepositoryCloudBase-AI-Toolkit
Skill namerelational-database-mcp-cloudbase
Stars
1.1K
Forks
141
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by TencentCloudBase on GitHub. Read the source before you install it.

Installation

Install the Relational Database Mcp Cloudbase AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/TencentCloudBase/CloudBase-AI-Toolkit.git /tmp/CloudBase-AI-Toolkit
mkdir -p .claude/skills
cp -r /tmp/CloudBase-AI-Toolkit/config/source/skills/relational-database-mcp-cloudbase .claude/skills/relational-database-mcp-cloudbase
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Relational Database Mcp Cloudbase in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Relational Database Mcp Cloudbase on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Relational Database Mcp Cloudbase is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Sibling skills (local only)

Sibling CloudBase skills ship beside this skill. Use local relative paths such as ../auth-tool-cloudbase/SKILL.md.

If a referenced sibling skill file is missing from this environment, ask the user to install the full CloudBase plugin (or the missing skill). Do not HTTP-fetch remote skill or protocol markdown into the agent context.

Activation Contract

Use this first when

  • The agent must inspect SQL data, execute SQL statements, provision or destroy MySQL, initialize table structure, or manage table security rules through MCP tools.

Read before writing code if

  • The task includes queryMysqlDatabase, manageMysqlDatabase, queryPermissions, or managePermissions.

Then also read

  • Web application integration -> ../relational-database-web-cloudbase/SKILL.md
  • Raw HTTP database access -> ../http-api-cloudbase/SKILL.md

Do NOT use for

  • Frontend or backend application code that should use SDKs instead of MCP operations.

Common mistakes / gotchas

  • Initializing SDKs in an MCP management flow.
  • Running write SQL or DDL before checking whether MySQL is provisioned and ready.
  • Treating document database tasks as MySQL management tasks.
  • Skipping _openid and permissions review after creating new SQL tables.
  • Destroying MySQL without explicit confirmation or without checking whether the environment still needs the instance.
  • Using getConnectionInfo (or inferred host/password) to build a default TCP client for new apps. Prefer SDK / runQuery / runStatement; TCP credentials are an explicit migration exception only.

When to use this skill

Use this skill when an agent needs to operate on CloudBase Relational Database via MCP tools, for example:

  • Inspecting or querying SQL data
  • Provisioning MySQL for an environment
  • Destroying MySQL for an environment
  • Polling MySQL provisioning status
  • Modifying data or schema (INSERT/UPDATE/DELETE/DDL)
  • Initializing tables and indexes after MySQL is ready
  • Reading or changing table permissions

Do NOT use this skill for:

  • Building Web or Node.js applications that talk to CloudBase Relational Database directly through SDKs
  • Auth flows or user identity management

How to use this skill (for a coding agent)

  1. Recognize MCP context

    • If you can call tools like queryMysqlDatabase, manageMysqlDatabase, queryPermissions, managePermissions, you are in MCP context.
    • In this context, never initialize SDKs for CloudBase Relational Database; use MCP tools instead.
  2. Pick the right tool for the job

    • Read-only SQL and provisioning status checks -> queryMysqlDatabase
    • MySQL provisioning, MySQL destruction, write SQL, DDL, schema initialization -> manageMysqlDatabase
    • Inspect permissions -> queryPermissions(action="getResourcePermission")
    • Change permissions -> managePermissions(action="updateResourcePermission")
  3. Always be explicit about safety

    • Before destructive operations (DELETE, DROP, etc.), summarize what you are about to run and why.
    • Prefer queryMysqlDatabase(action="getInstanceInfo") or a read-only SQL check before writes.
    • Provisioning or destroying MySQL requires explicit confirmation because both actions have environment-level impact.

Available MCP tools (CloudBase Relational Database)

These tools are the supported way to interact with CloudBase Relational Database via MCP:

1. queryMysqlDatabase

  • Purpose: Query SQL data and provisioning state.
  • Use for:
    • Running SELECT and other read-only SQL queries with action="runQuery"
    • Checking whether MySQL already exists with action="getInstanceInfo" (lifecycle only — no connection credentials)
    • Inspecting asynchronous provisioning progress with action="describeCreateResult" or action="describeTaskStatus"
    • Exception only: action="getConnectionInfo" returns the raw connection/cluster payload (may include credentials) for migrating existing TCP/ORM clients. Do not use this for new business CRUD — prefer Web/Node SDK or runQuery / runStatement.

Example flow:

json
{
  "action": "runQuery",
  "sql": "SELECT id, email FROM users ORDER BY created_at DESC LIMIT 50"
}

Do NOT call getConnectionInfo and then wire pymysql / mysql2 / DATABASE_URL into a cloud function for greenfield apps. Platform-delegated SQL and SDK access are the default.

2. manageMysqlDatabase

  • Purpose: Manage SQL lifecycle and execute mutating SQL.
  • Use for:
    • Provisioning MySQL with action="provisionMySQL"
    • Destroying MySQL with action="destroyMySQL"
    • Executing INSERT, UPDATE, DELETE, CREATE TABLE, ALTER TABLE, DROP TABLE with action="runStatement"
    • Initializing tables and indexes with action="initializeSchema"

Important: When creating a new table, you must include the _openid column for per-user access control:

sql
_openid VARCHAR(64) DEFAULT '' NOT NULL

Note: when a user is logged in, _openid is automatically populated by the server from the authenticated session. Do not manually fill it in normal inserts.

Before calling this tool, confirm:

  • The current environment has a ready MySQL instance, or you have just provisioned one.
  • The target tables and conditions are correct.
  • You have run a corresponding read-only query when appropriate.

When destroying MySQL, confirm:

  • The current environment really should lose the SQL instance.
  • You have explicit confirmation for the destructive action.
  • You are prepared to query describeTaskStatus afterward to inspect the destroy result.

3. queryPermissions

  • Purpose: Read permission configuration for a given SQL table.
  • Use for:
    • Understanding who can read/write a table
    • Auditing permissions on sensitive tables
    • Call shape: queryPermissions(action="getResourcePermission", resourceType="sqlDatabase", resourceId="<tableName>")

4. managePermissions

  • Purpose: Set or update permissions for a given SQL table.
  • Use for:
    • Hardening access to sensitive data
    • Opening up read access while restricting writes
    • Updating resource-level permission configuration
    • Call shape: managePermissions(action="updateResourcePermission", resourceType="sqlDatabase", resourceId="<tableName>", permission="READONLY")

Compatibility

  • Canonical plugin name: permissions
  • Legacy plugin aliases security-rule, security-rules, secret-rule, secret-rules, and access-control are still routed to permissions
  • Legacy tools readSecurityRule and writeSecurityRule are removed; always use queryPermissions and managePermissions

Recommended lifecycle flow

Scenario 1: MySQL is not provisioned yet

  1. Call queryMysqlDatabase(action="getInstanceInfo").
  2. If no instance exists, call manageMysqlDatabase(action="provisionMySQL", confirm=true).
  3. Poll provisioning status with:
    • queryMysqlDatabase(action="describeCreateResult")
    • queryMysqlDatabase(action="describeTaskStatus")
  4. Only continue when the returned lifecycle status is READY.
  5. For MySQL provisioning, prefer describeCreateResult; reserve describeTaskStatus for destroy flows whose task response carries TaskName.

Scenario 2: Safely inspect data in a table

  1. Use queryMysqlDatabase(action="runQuery") with a limited SELECT.
  2. Include LIMIT and relevant filters.
  3. Review the result set and confirm it matches expectations before any write operation.

Scenario 3: Apply schema initialization after provisioning

  1. Confirm MySQL is ready.
  2. Prepare ordered DDL statements.
  3. Run them through manageMysqlDatabase(action="initializeSchema").
  4. After creating tables, verify permissions with queryPermissions or managePermissions.

Scenario 4: Execute a targeted write or DDL change

  1. Use queryMysqlDatabase(action="runQuery") to inspect current data or schema if needed.
  2. Run the mutation once with manageMysqlDatabase(action="runStatement").
  3. Validate with another read-only query or by checking security rules.

Scenario 5: Destroy MySQL when the environment no longer needs it

  1. Use queryMysqlDatabase(action="getInstanceInfo") to confirm the current environment still has a SQL instance.
  2. Call manageMysqlDatabase(action="destroyMySQL", confirm=true).
  3. Query queryMysqlDatabase(action="describeTaskStatus") until the destroy task completes or fails.
  4. If the task succeeds, optionally call queryMysqlDatabase(action="getInstanceInfo") to confirm the instance no longer exists.
  5. If the task fails, treat the returned error as the terminal result and let the caller decide whether to retry.

Key principle: MCP tools vs SDKs

  • MCP tools are for agent operations and database management:

    • Provision MySQL.
    • Destroy MySQL.
    • Poll lifecycle state.
    • Run ad-hoc SQL.
    • Inspect and change resource permissions.
    • Do not depend on application auth state.
  • SDKs are for application code:

    • Frontend Web apps -> Web Relational Database skill.
    • Backend Node apps -> Node Relational Database quickstart.

When working as an MCP agent, always prefer these MCP tools for CloudBase Relational Database, and avoid mixing them with SDK initialization in the same flow.

Frequently asked questions

What does the Relational Database Mcp Cloudbase AI skill do?

[Deprecated] This is the required documentation for agents operating on the CloudBase Relational Database through MCP. It defines the canonical SQL management flow with `queryMysqlDatabase`, `manageMysqlDatabase`, `queryPermissions`, and `managePermissions`, including MySQL provisioning, destroy flow, async status checks, safe query execution, schema initialization, and permission updates. New environments should use PostgreSQL — see postgresql-development skill instead.

Why use Relational Database Mcp Cloudbase on TypingMind?

Because you install it once and use it with any model. Relational Database Mcp Cloudbase is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Relational Database Mcp Cloudbase in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/TencentCloudBase/CloudBase-AI-Toolkit/tree/main/config/source/skills/relational-database-mcp-cloudbase. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Relational Database Mcp Cloudbase?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Relational Database Mcp Cloudbase?

As many as you like. As long as a model supports skills, you can use Relational Database Mcp Cloudbase with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Relational Database Mcp Cloudbase AI skill free?

Yes. It is published on GitHub by TencentCloudBase under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇