Cloiudflare MCP Server

🚀 Cloudflare 人工智能

このリポジトリには、クライアントで Cloudflare の人工知能サービスを利用するための様々なパッケージとサンプルアプリケーションが含まれています。これは、Nx と Changesets をサポートするモノレポです。

✨ 主な機能

パッケージ

• workers-ai-provider: Vercel AI SDK で Workers AI のモデルを使用できるようにするカスタムプロバイダーです。

📦 インストール

ローカル開発

1. リポジトリをクローンします。

   git clone git@github.com:cloudflare/ai.git
   

2. 依存関係をインストールします。 ルートディレクトリで以下のコマンドを実行します。

   cd ai
   npm install
   

💻 使用例

基本的な使用法

開発

特定のアプリケーション（例: tool-calling）の開発サーバーを起動するには、以下のコマンドを実行します。

npx nx dev tool-calling

理想的には、すべてのコマンドはリポジトリのルートディレクトリから npx nx をプレフィックスとして実行する必要があります。これにより、あるパッケージが別のパッケージの出力に依存する場合など、依存関係グラフが正しく管理されます。

テストとコードチェック

• 特定のプロジェクト（例: workers-ai-provider）の継続的インテグレーションテストを実行するには、以下のコマンドを実行します。

npx nx test:ci workers-ai-provider

• 特定のプロジェクトのコードチェックを行うには、以下のコマンドを実行します。

npx nx lint my-project

• 1つまたは複数のプロジェクトに対して、より包括的なタスク（コードチェック、テスト、型チェック、ビルド）を実行するには、以下のコマンドを実行します。

npx nx run-many -t lint test:ci type-check build -p "my-project other-project"

その他の Nx タスク

• build: プロジェクトまたはプロジェクトのグループをコンパイルします。
• test: プロジェクトのテストをウォッチモードで実行します。
• test:ci: CI モードでテストを実行します（ウォッチなし）。
• test:smoke: スモークテストを実行します。
• type-check: TypeScript の型チェックを実行します。

高度な使用法

新しいサンプルアプリの作成

新しいサンプルアプリを作成するには、create-demo スクリプトを使用できます。このスクリプトは demos ディレクトリに新しいサンプルアプリを作成します。

npm run create-demo <demo-name>

アプリを作成した後、npm install を実行して依存関係をインストールし、npx nx cf-typegen <demo-name> を実行してサンプルアプリの型を生成します。その後、以下のコマンドでアプリを起動します。

npx nx dev <demo-name>

📚 ドキュメント

貢献

貢献を歓迎し、プルリクエストの提出を奨励しています。以下のガイドラインに従ってください。

1. プロジェクトのセットアップ: フォークまたはクローンした後、npm install を実行して依存関係をインストールします。
2. ブランチ戦略: 機能または修正のために新しいブランチを作成します。
3. 変更を加える:

• テストを追加または更新します。
• コードをコミットする際には、明確なコミットメッセージを含め、git commit --fixup または git add -p を使用してレビューを簡素化することを検討してください。

4. pre-commit フックを使用する: リポジトリには、コミット前にコードを整形するための pre-commit フックが提供されています。これを有効にするには、.git/hooks/ ディレクトリに追加します。

   ln -sf ../../.git/hooks/pre-commit .git/hooks/
   

5. Changesets を使用する: 小さなバージョン更新の場合は、changelog.json ファイルを作成してコミットします。

リリースフロー

1. 新しい機能ブランチを作成します。

   git checkout -b feature/my-new-feature
   

2. コードをコミットし、コミットごとに整形チェックを実行します。

   npm run prepare-commit
   

3. すべての変更を完了した後、新しい changelog.json ファイルを作成するか、既存のファイルを更新して変更を記録します。新しい変更ログファイルを生成するには、以下のコマンドを実行します。

   npm run new-changelog
   

4. changelog.json をコミットします。

   git add packages/*/changelog.json
   git commit -m "update changelog"
   

5. リモートリポジトリにプッシュし、プルリクエストを作成します。
6. マージ後、GitHub Actions ワークフローを実行して新しいバージョンを自動的にリリースします。バージョンとビルドの処理方法については、.github/workflows/ci.yml のロジックを参照してください。
7. 注意: package.json または yarn.lock ファイルを直接変更しないでください。必要な変更であり、チームと相談した場合を除きます。