{"id":47765428,"url":"https://github.com/tidbcloud/skills","last_synced_at":"2026-04-03T06:19:25.395Z","repository":{"id":337992554,"uuid":"1155293234","full_name":"tidbcloud/skills","owner":"tidbcloud","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-12T14:18:40.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-12T18:33:40.705Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tidbcloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-11T10:50:46.000Z","updated_at":"2026-02-12T14:22:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/tidbcloud/skills","commit_stats":null,"previous_names":["tidbcloud/skills"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/tidbcloud/skills","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fskills","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fskills/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fskills/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fskills/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidbcloud","download_url":"https://codeload.github.com/tidbcloud/skills/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fskills/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31338766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T06:12:52.500Z","status":"ssl_error","status_checked_at":"2026-04-03T06:12:08.917Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-03T06:19:22.805Z","updated_at":"2026-04-03T06:19:25.388Z","avatar_url":"https://github.com/tidbcloud.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## tidbcloud-skills\n\nThis repo contains:\n- `tidbcloud-manager`: a skill for **TiDB Cloud (focusing on TiDBX)** API exploration + YAML scenario generation, plus a small local runner (`tidbcloud-manager`) used by the skill.\n- `tidb-zero`: a lightweight skill to create and use temporary/playground TiDB databases via one REST API (no `pip install -e .` required).\n\n`tidbcloud-manager` skill source lives in `skills/tidbcloud-manager/`.\n`tidb-zero` skill source lives in `skills/tidb-zero/`.\n\nSupported AI coding assistants:\n- **Codex CLI** (OpenAI)\n- **OpenCode**\n- **Cursor / Windsurf / antigravity**: configure per their skill docs (no extra files needed from this repo).\n- **Claude Code**: does not use `SKILL.md` directly; configure per Claude Code docs (you can still use the same `tidbcloud-manager` runner and prompts/rules).\n\n## Setup (venv)\n\nUse any Python environment manager you like (e.g. `uv`, `conda`, `venv`). A virtual environment is recommended but not required.\n\nBelow uses `venv` as an example (from repo root):\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npip install -e .\n```\n\n`tidbcloud-manager` is a general-purpose local runner/executor. It was originally built to support automated testing workflows, and is reused here as the skill execution backend.\n\n## Optional CLI prerequisites (recommended)\n\nSome tasks (running SQL, managing cloud resources, etc.) require extra CLIs installed locally.\n\n- `mysqlsh` (recommended): used for running SQL against clusters via `tidbcloud-manager secure-exec cli`\n- `mysql` (optional fallback): used only if `mysqlsh` is not available\n- `aws` / `az` / `gcloud` (optional): only needed when your task touches those clouds\n\n## Install the skill\n\n### Install `tidb-zero` (recommended)\n\nRecommended install command:\n```bash\nnpx skills add https://github.com/tidbcloud/skills --skill tidb-zero\n```\n\n### For Codex CLI\n\nCopy or symlink the skill directory to your Codex skills folder:\n\n```bash\nmkdir -p ~/.codex/skills\nln -s \"$(pwd)/skills/tidbcloud-manager\" ~/.codex/skills/tidbcloud-manager\n```\n\n### For OpenCode\n\nCopy or symlink the skill directory to your OpenCode skills folder (location depends on your OpenCode installation; follow its docs).\n\nCommon locations include:\n\n- `~/.config/opencode/skill/` (global)\n- `\u003crepo\u003e/.opencode/skill/` (project-local)\n\nCompatibility list (some installations also check these):\n\n- `~/.opencode/skill/`\n- `~/.config/opencode/skills/`\n- `~/.opencode/skills/`\n\nExample (global):\n\n```bash\nmkdir -p ~/.config/opencode/skill\nln -s \"$(pwd)/skills/tidbcloud-manager\" ~/.config/opencode/skill/tidbcloud-manager\n```\n\nEnsure the `tidbcloud-manager` executable is on `PATH` for new OpenCode sessions.\nIf you installed into a venv, you can symlink the executable and add it to `PATH`:\n\n```bash\nmkdir -p ~/.opencode/bin\nln -s \"$(pwd)/.venv/bin/tidbcloud-manager\" ~/.opencode/bin/tidbcloud-manager\nexport PATH=\"$HOME/.opencode/bin:$PATH\"\n```\n\nTip: add the `export PATH=...` line to your shell rc (e.g. `~/.zshrc`) to make it persistent.\n\n## Configure credentials (`.env`)\n\nCopy the `.env.example` to `.env` in the skill directory you installed and fill in values:\n\n```bash\n# Example (repo copy)\ncp skills/tidbcloud-manager/.env.example skills/tidbcloud-manager/.env\n\n# Example (Codex global install)\ncp ~/.codex/skills/tidbcloud-manager/.env.example ~/.codex/skills/tidbcloud-manager/.env\n```\n\nNotes:\n- `./.env` is auto-loaded when running from the skill directory (or when `TIDBCLOUD_MANAGER_SKILL_DIR` points to it).\n- Never commit `.env` (already ignored).\n\n## Run (manual)\n\nRun from the skill directory:\n\n```bash\ncd skills/tidbcloud-manager\ntidbcloud-manager secure-exec http '{\"method\":\"GET\",\"path\":\"/clusters\"}' --sut tidbx\n```\n\nOr run from repo root (auto-detects `./skills/tidbcloud-manager/`):\n```bash\ntidbcloud-manager secure-exec http '{\"method\":\"GET\",\"path\":\"/clusters\"}' --sut tidbx\n```\n\nIf you run from another directory and see `Cannot locate skill root (missing ./configs)`, set:\n\n```bash\nexport TIDBCLOUD_MANAGER_SKILL_DIR=\"/path/to/skills/tidbcloud-manager\"\n```\n\nSession workflow:\n\n```bash\ntidbcloud-manager session new tidbx demo\ntidbcloud-manager session status \u003csession_id\u003e\n```\n\n## OpenAPI helpers (optional)\n\nIf `openapi.json` is large, use these helpers instead of opening the whole file:\n\n```bash\ntidbcloud-manager openapi list --sut tidbx --query cluster\ntidbcloud-manager openapi extract --sut tidbx --operation-id ClusterService_CreateCluster\n```\n\n## Export knowledge (optional)\n\nAfter you run successful/failed operations multiple times locally, you can export curated knowledge back into the repo:\n\n```bash\ntidbcloud-manager knowledge export --sut tidbx\n```\n\n## Dedicated / Premium\n\nThe initial open-source release is **serverless-only**. Dedicated support is intentionally not published in the first iteration.\n\n## Prompt examples\n\nUse the skill trigger:\n\n```\n# Codex CLI / OpenCode (SKILL.md trigger)\ntidbx req: create a cluster named 'cluster-from-agent' with root password '...'\ntidbx req: delete the cluster\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fskills","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidbcloud%2Fskills","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fskills/lists"}