Cloiudflare MCP Server

🚀 Cloudflare 人工智能

本倉庫涵蓋了多種包和示例應用，旨在助力客戶端使用 Cloudflare 的人工智能服務。它是一個由 Nx 和 Changesets 提供支持的單代碼庫（monorepo）。

✨ 主要特性

• 提供自定義提供程序，可將 Workers AI 的模型用於 Vercel AI SDK。
• 藉助 create-demo 腳本，能輕鬆創建新的示例應用。

📦 安裝指南

克隆倉庫

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

安裝依賴項

在根目錄中運行以下命令：

cd ai
npm install

💻 使用示例

本地開發

啟動特定應用程序的開發服務器

以 tool-calling 應用為例：

npx nx dev tool-calling

提示：理想情況下，所有命令都應從倉庫根目錄使用 npx nx 前綴執行，這樣能確保依賴項圖正確管理，例如當一個包依賴於另一個包的輸出時。

測試和代碼檢查

• 執行持續集成測試：以 workers-ai-provider 項目為例

npx nx test:ci workers-ai-provider

• 進行代碼檢查：以 my-project 項目為例

npx nx lint my-project

• 運行更全面的任務：對 my-project 和 other-project 項目運行代碼檢查、測試、類型檢查、構建任務

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 文件，除非你確信所做的更改是必要的，並且已經與團隊討論過。