Cloiudflare MCP Server

🚀 Cloudflare Artificial Intelligence

This repository contains various packages and example applications for consuming Cloudflare's AI services on the client side. It's a monorepo powered by Nx and Changesets.

✨ Features

Packages

• : A custom provider that enables Workers AI's models for the Vercel AI SDK.

🚀 Quick Start

Local Development

1. Clone the repository.

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

2. Install dependencies. Run the following commands in the root directory:

   cd ai
   npm install
   

3. Start development. To start the development server for a specific application (e.g., tool-calling):

   npx nx dev tool-calling
   

   Ideally, all commands should be executed from the repository root with the npx nx prefix. This ensures that the dependency graph is correctly managed, for example, if one package depends on the output of another.
4. Testing and code inspection.
   • To execute continuous integration tests for a specific project (e.g., workers-ai-provider):

     npx nx test:ci workers-ai-provider
     

   • To perform code inspection on a specific project:

     npx nx lint my-project
     

   • Run more comprehensive tasks (e.g., code inspection, testing, type checking, building) on one or more projects:

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

5. Other Nx tasks.
   • build: Compile a project or a group of projects.
   • test: Run project tests in watch mode.
   • test:ci: Run tests in CI mode (no watching).
   • test:smoke: Run smoke tests.
   • type-check: Perform TypeScript type checking.

Creating a New Example Application

To create a new example application, you can use the create-demo script. This script will create a new example application in the demos directory.

npm run create-demo <demo-name>

After creating the application, npm install will be run to install dependencies, and npx nx cf-typegen <demo-name> will be run to generate types for the example application. Then simply start the application using the following command:

npx nx dev <demo-name>

🤝 Contribution

We welcome contributions and encourage you to submit pull requests. Please follow these guidelines:

1. Project setup: After forking or cloning, run npm install to install dependencies.
2. Branch strategy: Create a new branch for your feature or fix.
3. Make changes:
   • Add or update tests.
   • When committing code, ensure that you include clear commit messages and consider using git commit --fixup or git add -p to simplify the review process.
4. Use the pre-commit hook: A pre-commit hook is provided in the repository to format the code before committing. To enable it, add it to the .git/hooks/ directory:

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

5. Use Changesets: For minor version updates, create a changelog.json file and commit it.

🚀 Release Process

1. Create a new feature branch:

   git checkout -b feature/my-new-feature
   

2. Commit your code and run formatting checks on each commit:

   npm run prepare-commit
   

3. After making all changes, create a new changelog.json file or update an existing one to record the changes. You can generate a new changelog file using the following command:

   npm run new-changelog
   

4. Commit the changelog.json file:

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

5. Push to the remote repository and create a pull request.
6. After merging, run the GitHub Actions workflow to automatically publish a new version. Refer to the logic in .github/workflows/ci.yml to understand how versions and builds are handled.
7. Note: Do not directly modify the package.json or yarn.lock files unless you are sure the changes are necessary and have discussed them with the team.