Update README.md and add CONTRIBUTING.md in radar server

Maximo-Guk · Maximo-Guk · commit 209ea25bed2e · 2025-04-29T14:26:54.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# Developing
+
+## Architecture
+
+The monorepo has two top-level directories:
+
+- apps: Contains the Workers for each MCP server
+  - apps/workers-observability
+  - apps/workers-bindings
+  - [apps/radar/CONTRIBUTING.md](apps/radar/CONTRIBUTING.md)
+  - apps/cloudflare-one-casb
+- packages: Contains shared packages used across our various apps.
+  - packages/eslint-config: Eslint config used by all apps and packages.
+  - packages/typescript-config: tsconfig used by all apps and packages.
+  - packages/mcp-common: Shared common tools and scripts to help manage this repo.
+
+We use [TurboRepo](https://turbo.build/) and [pnpm](https://pnpm.io/) to manage this repository. TurboRepo manages the monorepo by ensuring commands are run across all apps.
+
+## Getting Started
+
+This section will guide you through setting up your developer environment and running tests.
+
+For more details on development in this monorepo, take a look at apps/workers-observability/CONTRIBUTING.md[/apps/workers-observability/CONTRIBUTING.md]
+
+### Testing
+
+The project uses Vitest as the testing framework with [fetchMock](https://developers.cloudflare.com/workers/testing/vitest-integration/test-apis/) for API mocking.
+
+#### Running Tests
+
+To run all tests:
+
+```bash
+pnpm test
+```
+
+To run a specific test file:
+
+```bash
+pnpm test -- tests/tools/queues.test.ts
+```
+
+To run tests in watch mode (useful during development):
+
+```bash
+pnpm test:watch
+```
diff --git a/README.md b/README.md
@@ -1,91 +1,43 @@
 # Cloudflare MCP Server
 
-Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) for managing context between large language models (LLMs) and external systems. In this repository, we provide an installer as well as an MCP Server for [Cloudflare's API](https://api.cloudflare.com).
+Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) for managing context between large language models (LLMs) and external systems. In this repository, you can find several MCP servers allowing you to connect to Cloudflare's service from an MCP client (e.g. Cursor, Claude Desktop) and use natural language to accomplish things on your Cloudflare account. The following servers are included in this repository:
 
-This lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things on your Cloudflare account, e.g.:
+| Server Name                                     | Description                                                                  | Server URL                                     |
+| ----------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------- |
+| [**Documentation server**](/apps/docs-autorag)  | Get up to date reference information on Cloudflare                           | `https://docs.mcp.cloudflare.com/sse`          |
+| [**Workers Bindings server**](/apps/bindings)   | Build Workers applications with storage, AI, and compute primitives          | `https://bindings.mcp.cloudflare.com/sse`      |
+| [**Observability server**](/apps/observability) | Debug and get insight into your application’s logs and analytics             | `https://observability.mcp.cloudflare.com/sse` |
+| [**Radar server**](/apps/radar)                 | Get global Internet traffic insights, trends, URL scans, and other utilities | `https://radar.mcp.cloudflare.com/sse`         |
 
-- `List all the Cloudflare workers on my <some-email>@gmail.com account.`
-- `Can you tell me about any potential issues on this particular worker '...'?`
+## Access the remote MCP server from any MCP client
 
-## Access the remote MCP server from Claude Desktop
+If your MCP client has first class support for remote MCP servers, the client will provide a way to accept the server URL directly within its interface (e.g. [Cloudflare AI Playground](https://playground.ai.cloudflare.com/))
 
-Open Claude Desktop and navigate to Settings -> Developer -> Edit Config. This opens the configuration file that controls which MCP servers Claude can access.
-
-Replace the content with the following configuration. Once you restart Claude Desktop, a browser window will open showing your OAuth login page. Complete the authentication flow to grant Claude access to your MCP server. After you grant access, the tools will become available for you to use.
+If your client does not yet support remote MCP servers, you will need to set up its resepective configuration file using mcp-remote (https://www.npmjs.com/package/mcp-remote) to specify which servers your client can access.
 
 ```json
 {
 	"mcpServers": {
-		"cloudflare": {
+		"cloudflare-observability": {
 			"command": "npx",
 			"args": ["mcp-remote", "https://observability.mcp.cloudflare.com/sse"]
+		},
+		"cloudflare-bindings": {
+			"command": "npx",
+			"args": ["mcp-remote", "https://bindings.mcp.cloudflare.com/sse"]
 		}
 	}
 }
 ```
 
 ## Need access to more Cloudflare tools?
 
-We're gradually moving over functionality to this remote MCP server repo. In the meantime please take a look at the local only mcp-server-cloudflare package which currently has more tools available.
-
-Visit <https://www.npmjs.com/package/@cloudflare/mcp-server-cloudflare>
+We're continuing to add more functionality to this remote MCP server repo. If you'd like to leave feedback, file a bug or provide a feature request, [please open an issue](https://github.com/cloudflare/mcp-server-cloudflare/issues/new/choose) on this repository
 
 ## Paid Features
 
 Some features may require a paid Cloudflare Workers plan. Ensure your Cloudflare account has the necessary subscription level for the features you intend to use.
 
-## Features
-
-### Workers Management
-
-- `worker_list`: List all Workers in your account
-- `worker_get_worker`: Get a Worker's script content
-
-### Workers Logs
-
-- `worker_logs_by_worker_name`: Analyze recent logs for a Cloudflare Worker by worker name
-- `worker_logs_by_ray_id`: Analyze recent logs across all workers for a specific request by Cloudflare Ray ID
-- `worker_logs_keys`: Get available telemetry keys for a Cloudflare Worker
-
-## Developing
-
-### Apps
-
-- [workers-observability](apps/workers-observability): The Workers Observability MCP server
-- [radar](apps/radar): The Cloudflare Radar MCP server
-
-### Packages
-
-- eslint-config: Eslint config used by all apps and packages.
-- typescript-config: tsconfig used by all apps and packages.
-- mcp-common: Shared common tools and scripts to help manage this repo.
-
-For more details on development in this monorepo, take a look at apps/workers-observability
-
-## Testing
-
-The project uses Vitest as the testing framework with MSW (Mock Service Worker) for API mocking.
-
-### Running Tests
-
-To run all tests:
-
-```bash
-pnpm test
-```
-
-To run a specific test file:
-
-```bash
-pnpm test -- tests/tools/queues.test.ts
-```
-
-To run tests in watch mode (useful during development):
-
-```bash
-pnpm test:watch
-```
-
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Interested in contributing, and running this server locally? See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
diff --git a/apps/radar/CONTRIBUTING.md b/apps/radar/CONTRIBUTING.md
@@ -0,0 +1,67 @@
+# Setup
+
+If you'd like to iterate and test your MCP server, you can do so in local development.
+
+## Local Development
+
+1. Create a `.dev.vars` file in your project root:
+
+   If you're a Cloudflare employee:
+
+   ```
+   CLOUDFLARE_CLIENT_ID=your_development_cloudflare_client_id
+   CLOUDFLARE_CLIENT_SECRET=your_development_cloudflare_client_secret
+   URL_SCANNER_API_TOKEN=your_development_url_scanner_api_token
+   ```
+
+   If you're an external contributor, you can provide a development API token:
+
+   ```
+   DEV_DISABLE_OAUTH=true
+   # This is your global api token
+   DEV_CLOUDFLARE_API_TOKEN=your_development_api_token
+   URL_SCANNER_API_TOKEN=your_development_url_scanner_api_token
+   ```
+
+2. Start the local development server:
+
+   ```bash
+   npx wrangler dev
+   ```
+
+3. To test locally, open Inspector, and connect to `http://localhost:8976/sse`.
+   Once you follow the prompts, you'll be able to "List Tools". You can also connect with any MCP client.
+
+## Deploying the Worker ( Cloudflare employees only )
+
+Set secrets via Wrangler:
+
+```bash
+npx wrangler secret put CLOUDFLARE_CLIENT_ID -e <ENVIRONMENT>
+npx wrangler secret put CLOUDFLARE_CLIENT_SECRET -e <ENVIRONMENT>
+npx wrangler secret put URL_SCANNER_API_TOKEN -e <ENVIRONMENT>
+```
+
+## Set up a KV namespace
+
+Create the KV namespace:
+
+```bash
+npx wrangler kv namespace create "OAUTH_KV"
+```
+
+Then, update the Wrangler file with the generated KV namespace ID.
+
+## Deploy & Test
+
+Deploy the MCP server to make it available on your workers.dev domain:
+
+```bash
+npx wrangler deploy -e <ENVIRONMENT>
+```
+
+Test the remote server using [Inspector](https://modelcontextprotocol.io/docs/tools/inspector):
+
+```bash
+npx @modelcontextprotocol/inspector@latest
+```
diff --git a/apps/radar/README.md b/apps/radar/README.md
@@ -34,10 +34,11 @@ This MCP server is still a work in progress, and we plan to add more tools in th
 - `Give me rank details for google.com in March 2025.`
 - `Scan https://example.com.`
 
-## Access the remote MCP server from Claude Desktop
+## Access the remote MCP server from from any MCP Client
 
-Open Claude Desktop and navigate to `Settings -> Developer -> Edit Config`.
-This opens the configuration file that controls which MCP servers Claude can access.
+If your MCP client has first class support for remote MCP servers, the client will provide a way to accept the server URL directly within its interface (e.g. [Cloudflare AI Playground](https://playground.ai.cloudflare.com/))
+
+If your client does not yet support remote MCP servers, you will need to set up its resepective configuration file using mcp-remote (https://www.npmjs.com/package/mcp-remote) to specify which servers your client can access.
 
 Replace the content with the following configuration:
 
@@ -52,66 +53,6 @@ Replace the content with the following configuration:
 }
 ```
 
-Once you restart Claude Desktop, a browser window will open showing your OAuth login page.
-Complete the authentication flow to grant Claude access to your MCP server.
-After you grant access, the tools will become available for you to use.
-
-## Setup
-
-#### Secrets
-
-Set secrets via Wrangler:
-
-```bash
-npx wrangler secret put CLOUDFLARE_CLIENT_ID -e <ENVIRONMENT>
-npx wrangler secret put CLOUDFLARE_CLIENT_SECRET -e <ENVIRONMENT>
-npx wrangler secret put URL_SCANNER_API_TOKEN -e <ENVIRONMENT>
-```
-
-#### Set up a KV namespace
-
-Create the KV namespace:
-
-```bash
-npx wrangler kv namespace create "OAUTH_KV"
-```
-
-Then, update the Wrangler file with the generated KV namespace ID.
-
-#### Deploy & Test
-
-Deploy the MCP server to make it available on your workers.dev domain:
-
-```bash
-npx wrangler deploy -e <ENVIRONMENT>
-```
-
-Test the remote server using [Inspector](https://modelcontextprotocol.io/docs/tools/inspector):
-
-```bash
-npx @modelcontextprotocol/inspector@latest
-```
-
-## Local Development
-
-If you'd like to iterate and test your MCP server, you can do so in local development.
-This will require you to create another OAuth App on Cloudflare:
-
-1. Create a `.dev.vars` file in your project root with:
-
-   ```
-   CLOUDFLARE_CLIENT_ID=your_development_cloudflare_client_id
-   CLOUDFLARE_CLIENT_SECRET=your_development_cloudflare_client_secret
-   URL_SCANNER_API_TOKEN=your_development_url_scanner_api_token
-   ```
-
-2. Start the local development server:
-
-   ```bash
-   npx wrangler dev
-   ```
-
-3. To test locally, open Inspector, and connect to `http://localhost:8976/sse`.
-   Once you follow the prompts, you'll be able to "List Tools".
+Once you've set up your configuration file, restart MCP client and a browser window will open showing your OAuth login page. Proceed through the authentication flow to grant the client access to your MCP server. After you grant access, the tools will become available for you to use.
 
-   You can also connect to Claude Desktop.
+Interested in contributing, and running this server locally? See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
