mcpField
C
cloudbase-guidelines

cloudbase-guidelines

github.com/tencentcloudbaseクラウド・DevOps1.2k38 回インストール1 日前に更新
リポジトリ

cloudbase-guidelines について

cloudbase-guidelinesは、CloudBaseでWeb、ミニプログラム、ネイティブアプリを開発するコーディングエージェント向けのスキルです。プラットフォーム別の開発手順に加え、MCPの設定方法やCLIでの代替手段をまとめています。

主な機能

  1. 01プラットフォーム別のCloudBase開発ガイド
  2. 02認証とデータベースの選択指針
  3. 03デプロイ手順のガイダンス
  4. 04MCP設定とmcporter CLIの説明

活用シーン

  1. 01CloudBaseのWebプロジェクトの計画
  2. 02WeChatミニプログラムの開発
  3. 03CloudBaseを使ったネイティブアプリ開発
  4. 04CloudBaseのフロントエンドとバックエンドのデプロイ

MCP 対応

コーディングエージェントに@cloudbase/cloudbase-mcpサーバーを設定する方法を推奨しています。MCPを利用できない場合に、mcporterでMCPツールを一覧表示して呼び出す方法も説明します。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tencentcloudbase/cloudbase-ai-toolkit --skill cloudbase-guidelines

インストール後、Claude Code で/cloudbase-guidelinesを入力して読み込まれたか確認します。

詳細

CloudBase 開発ガイドライン

💡 推奨：MCP のインストール

CloudBase の開発体験を向上させるため、CloudBase MCP（Model Context Protocol）のインストールをおすすめします。

CloudBase MCP では、環境管理、関数のデプロイ、データベース操作など、CloudBase 開発に欠かせないツールを利用できます。必須ではありませんが、MCP をインストールすると開発ワークフローが大幅に改善されます。

MCP の設定手順

ほとんどのコーディングエージェントは、プロジェクト単位の MCP 設定に対応しています。標準的な JSON 設定の構造は次のとおりです。

{
  "mcpServers": {
    "cloudbase": {
      "command": "npx",
      "args": ["@cloudbase/cloudbase-mcp@latest"]
    }
  }
}

プロジェクト単位の設定ファイルの場所：

  • Cursor：.cursor/mcp.json
  • Claude Code：.mcp.json
  • Windsurf：~/.codeium/windsurf/mcp_config.json（ユーザー単位。プロジェクト単位の JSON 設定はありません）
  • Cline：プロジェクト単位の MCP 設定ファイルの場所を Cline の設定で確認してください
  • GitHub Copilot Chat (VS Code)：MCP 設定ファイルの場所を VS Code の設定で確認してください

形式の違い：

  • Continue：.continue/mcpServers/ フォルダーで YAML 形式を使用します。
name: CloudBase MCP
version: 1.0.0
schema: v1
mcpServers:
  - uses: stdio
    command: npx
    args: ["@cloudbase/cloudbase-mcp@latest"]
MCP を利用できない場合の mcporter（CLI）の使用

MCP に対応していない環境（例：moltbot）や、MCP の設定方法がわからない場合は、CLI として mcporter を使用し、MCP ツールを呼び出します。mcporter の設定に Secret ID、Secret Key、Env ID が設定されていることをユーザーに確認してください。

設定： デフォルトは ./config/mcporter.json です（--config で上書きできます）。機械可読な結果を得るには、--output json を推奨します。

{
  "mcpServers": {
    "cloudbase-mcp": {
      "description": "CloudBase MCP",
      "command": "npx",
      "args": ["@cloudbase/cloudbase-mcp@latest"],
      "env": {
        "TENCENTCLOUD_SECRETID": "<your_secret_id>",
        "TENCENTCLOUD_SECRETKEY": "<your_secret_key>",
        "CLOUDBASE_ENV_ID": "<your_env_id>"
      }
    }
  }
}

クイックスタート：

  • mcporter list — サーバー／ツールの一覧を表示
  • mcporter list <server> --schema — ツールのスキーマを表示
  • mcporter call <server.tool> key=value — ツールを呼び出す

呼び出し例：

  • セレクター：mcporter call linear.list_issues team=ENG limit:5
  • 関数構文：mcporter call "linear.create_issue(title: \"Bug\")"
  • JSON ペイロード：mcporter call <server.tool> --args '{"limit":5}'

クイックリファレンス

Web プロジェクトを開発する場合：
  1. プラットフォーム：SDK の統合、静的ホスティング、ビルド設定については、web-development スキルを読んでください
  2. 認証：auth-web と auth-tool のスキルを読んでください。Web SDK に組み込まれた認証を使用します
  3. データベース：
    • NoSQL：no-sql-web-sdk スキル
    • MySQL：relational-database-web と relational-database-tool のスキル
  4. UI デザイン（推奨）：より良い UI／UX デザインのガイドラインについては、ui-design スキルを読んでください
ミニプログラムプロジェクトを開発する場合：
  1. プラットフォーム：プロジェクト構成、WeChat Developer Tools、wx.cloud の使用方法については、miniprogram-development スキルを読んでください
  2. 認証：auth-wechat スキルを読んでください。ログイン不要で、クラウド関数内で OPENID を取得できます
  3. データベース：
    • NoSQL：no-sql-wx-mp-sdk スキル
    • MySQL：relational-database-tool スキル（ツール経由）
  4. UI デザイン（推奨）：より良い UI／UX デザインのガイドラインについては、ui-design スキルを読んでください
ネイティブアプリプロジェクト（iOS／Android／Flutter／React Native など）を開発する場合：
  1. ⚠️ プラットフォームの制限：ネイティブアプリは CloudBase SDK に対応していません。HTTP API を使用する必要があります
  2. 必須スキル：
    • http-api — すべての CloudBase 操作で使用する HTTP API
    • relational-database-tool — MySQL データベース操作（ツール経由）
    • auth-tool — 認証設定
  3. ⚠️ データベースの制限：対応しているのは MySQL データベースのみです。MySQL が必要な場合は、コンソールで有効にするようユーザーに案内してください：CloudBase コンソール - MySQL データベース

主な機能

1. 認証

プラットフォーム別の認証方法：

  • Web プロジェクト：CloudBase Web SDK に組み込まれた認証機能を使用します。auth-web スキルを参照してください
  • ミニプログラムプロジェクト：通常、ログインは不要です。クラウド関数で wxContext.OPENID を取得してください。auth-wechat スキルを参照してください
  • Node.js バックエンド：auth-nodejs スキルを参照してください

設定：

  • ユーザーが認証要件に言及した場合は、auth-tool スキルを読み、認証プロバイダーを設定してください
  • フロントエンドコードを実装する前に、必要な認証方法を確認して有効にしてください
2. データベース操作

Web プロジェクト：

  • NoSQL データベース：no-sql-web-sdk スキルを参照してください
  • MySQL リレーショナルデータベース：relational-database-web スキル（Web）と relational-database-tool スキル（管理）を参照してください

ミニプログラムプロジェクト：

  • NoSQL データベース：no-sql-wx-mp-sdk スキルを参照してください
  • MySQL リレーショナルデータベース：relational-database-tool スキル（ツール経由）を参照してください
3. デプロイ

静的ホスティング（Web）：

  • ビルド完了後に CloudBase 静的ホスティングを使用してください
  • デプロイ手順については、web-development スキルを参照してください
  • デプロイ後、CDN のキャッシュが数分間残ることをユーザーに伝えてください

バックエンドのデプロイ：

  • Cloud Functions：cloud-functions スキルを参照してください。作成後にランタイムを変更することはできないため、最初に正しいランタイムを選択する必要があります
  • CloudRun：cloudrun-development スキルを参照してください。バックエンドコードが CORS に対応していることを確認し、コンテナタイプの場合は Dockerfile を用意してください
4. UI デザイン（推奨）

より優れた UI/UX デザインを実現するため、以下を提供する ui-design スキルの参照を検討してください：

  • デザイン思考のフレームワーク
  • フロントエンドの美学に関するガイドライン
  • 独自性と品質の高いインターフェースを作成するためのベストプラクティス

プラットフォーム固有のスキル

Web プロジェクト
  • web-development - SDK 統合、静的ホスティング、ビルド設定
  • auth-web - Web SDK に組み込まれた認証機能
  • no-sql-web-sdk - NoSQL データベース操作
  • relational-database-web - MySQL データベース操作（Web）
  • relational-database-tool - MySQL データベース管理
  • cloud-storage-web - クラウドストレージ操作
  • ai-model-web - Web アプリでの AI モデル呼び出し
ミニプログラムプロジェクト
  • miniprogram-development - プロジェクト構成、WeChat Developer Tools、wx.cloud
  • auth-wechat - 認証（通常、ログインは不要）
  • no-sql-wx-mp-sdk - NoSQL データベース操作
  • relational-database-tool - MySQL データベース操作
  • ai-model-wechat - ミニプログラムでの AI モデル呼び出し
ネイティブアプリプロジェクト
  • http-api - HTTP API の使用（必須 - SDK はサポートされていません）
  • relational-database-tool - MySQL データベース操作（必須）
  • auth-tool - 認証設定
共通スキル
  • cloudbase-platform - CloudBase プラットフォーム全般の知識
  • ui-design - UI デザインのガイドライン（推奨）
  • spec-workflow - 標準的なソフトウェアエンジニアリングプロセス

専門スキルのリファレンス

プラットフォーム開発スキル
  • Web：web-development - SDK 統合、静的ホスティング、ビルド設定
  • ミニプログラム：miniprogram-development - プロジェクト構成、WeChat Developer Tools、wx.cloud
  • Cloud Functions：cloud-functions - クラウド関数の開発、デプロイ、ログ記録、HTTP アクセス
  • CloudRun：cloudrun-development - バックエンドのデプロイ（関数／コンテナ）
  • プラットフォーム（共通）：cloudbase-platform - 環境、認証、サービス
認証スキル
  • Web：auth-web - Web SDK に組み込まれた認証機能を使用
  • ミニプログラム：auth-wechat - 通常、ログインは不要。クラウド関数で OPENID を取得
  • Node.js：auth-nodejs
  • 認証ツール：auth-tool - 認証プロバイダーの設定と管理
データベーススキル
  • NoSQL（Web）：no-sql-web-sdk
  • NoSQL（ミニプログラム）：no-sql-wx-mp-sdk
  • MySQL（Web）：relational-database-web
  • MySQL（ツール）：relational-database-tool
ストレージスキル
  • クラウドストレージ（Web）：cloud-storage-web - アップロード、ダウンロード、一時 URL、ファイル管理
AI スキル
  • AI モデル（Web）：ai-model-web - @cloudbase/js-sdk によるテキスト生成とストリーミング
  • AI モデル（Node.js）：ai-model-nodejs - @cloudbase/node-sdk ≥3.16.0 によるテキスト生成、ストリーミング、画像生成
  • AI モデル（WeChat）：ai-model-wechat - wx.cloud.extend.AI とコールバックによるテキスト生成とストリーミング
UI デザインスキル
  • ui-design - デザイン思考フレームワーク、フロントエンドの美しさに関するガイドライン（UI 作業に推奨）
ワークフロースキル
  • 仕様ワークフロー：spec-workflow - 標準的なソフトウェアエンジニアリングプロセス（要件、設計、タスク）

基本動作ルール

  1. プロジェクトの理解：現在のプロジェクトの README.md を読み、プロジェクトの指示に従います
  2. 開発順序：まずフロントエンドを優先し、その後バックエンドに取り組みます
  3. バックエンド戦略：特に必要な場合を除き、クラウド関数を介さず、SDK を使って CloudBase データベースを直接呼び出すことを優先します
  4. デプロイ順序：バックエンドの依存関係がある場合は、フロントエンドをプレビューする前にバックエンドをデプロイします
  5. 認証ルール：組み込みの認証関数を使用し、プラットフォームごとに認証方法を使い分けます
    • Web プロジェクト：CloudBase Web SDK の組み込み認証を使用します（auth-web を参照）
    • ミニプログラムプロジェクト：通常、ログインは不要です。クラウド関数で OPENID を取得します（auth-wechat を参照）
    • ネイティブアプリ：認証には HTTP API を使用します（http-api を参照）
  6. ネイティブアプリ開発：ネイティブアプリでは CloudBase SDK は利用できません。必ず HTTP API を使用してください。サポートされるデータベースは MySQL のみです。

デプロイワークフロー

ユーザーから CloudBase へのデプロイを依頼された場合：

  1. 既存のデプロイを確認：

    • README.md を読み、既存のデプロイ情報を確認します
    • 以前にデプロイされたサービスとその URL を特定します
    • 新規デプロイか、既存サービスの更新かを判断します

  2. バックエンドのデプロイ（該当する場合）：

    • nodejs クラウド関数の場合のみ、createFunction ツールを使って直接デプロイします
      • 条件：関数ディレクトリに、クラウド関数形式のエクスポート exports.main = async (event, context) => {} を含む index.js があること
    • その他の言語のバックエンドサーバー（Java、Go、PHP、Python、Node.js）は、Cloud Run にデプロイします
    • バックエンドコードがデフォルトで CORS に対応するようにします
    • コンテナ化デプロイ用の Dockerfile を用意します
    • デプロイには manageCloudRun ツールを使用します
    • コールドスタートの遅延を減らすため、MinNum インスタンスを 1 以上に設定します

  3. フロントエンドのデプロイ（該当する場合）：

    • バックエンドのデプロイ完了後、返された API アドレスを使ってフロントエンドの API エンドポイントを更新します
    • フロントエンドアプリケーションをビルドします
    • ホスティングツールを使って CloudBase 静的ホスティングにデプロイします

  4. デプロイ URL の表示：

    • バックエンドのデプロイ URL（該当する場合）を表示します
    • パスの末尾にスラッシュ（/）を付けて、フロントエンドのデプロイ URL を表示します
    • CDN キャッシュを確実に更新するため、フロントエンド URL にランダムなクエリ文字列を追加します

  5. ドキュメントの更新：

    • デプロイ情報とサービスの詳細を README.md に記載します
    • バックエンド API エンドポイントとフロントエンドのアクセス URL を含めます
    • 使用した CloudBase リソース（関数、Cloud Run、ホスティング、データベースなど）を記録します
    • これにより、今後の更新とメンテナンスが容易になります

CloudBase コンソールのエントリーポイント

リソースの作成またはデプロイ後、対応するコンソール管理ページへのリンクを提示します。すべてのコンソール URL は次の形式です：https://tcb.cloud.tencent.com/dev?envId=${envId}#/{path}

主な機能のエントリーポイント
  1. 概要（概览）: #/overview - メインダッシュボード
  2. テンプレートセンター（模板中心）: #/cloud-template/market - プロジェクトテンプレート
  3. ドキュメントデータベース（文档型数据库）: #/db/doc - NoSQL コレクション: #/db/doc/collection/${collectionName}、モデル: #/db/doc/model/${modelName}
  4. MySQL データベース（MySQL 数据库）: #/db/mysql - テーブル: #/db/mysql/table/default/
  5. クラウド関数（云函数）: #/scf - 関数の詳細: #/scf/detail?id=${functionName}&NameSpace=${envId}
  6. CloudRun（云托管）: #/platform-run - コンテナーサービス
  7. クラウドストレージ（云存储）: #/storage - ファイルストレージ
  8. AI+: #/ai - AI 機能
  9. 静的ウェブサイトホスティング（静态网站托管）: #/static-hosting
  10. ID 認証（身份认证）: #/identity - ログイン: #/identity/login-manage、トークン: #/identity/token-management
  11. Weida ローコード（微搭低代码）: #/lowcode/apps
  12. ログとモニタリング（日志监控）: #/devops/log
  13. 拡張機能（扩展功能）: #/apis
  14. 環境設定（环境配置）: #/env

コメント

Markdown 対応