improve README.md

Author: andre-j3sus

apps/radar/README.md

@@ -2,28 +2,71 @@
 
 This is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that supports remote MCP connections, with Cloudflare OAuth built-in.
 
+It features tools powered by the [Cloudflare Radar API](https://developers.cloudflare.com/radar/).
+
+## Tools
+
+Currently available tools:
+
+- `list_autonomous_systems`: Lists autonomous systems (filterable by location and sortable by population size)
+- `get_as_details`: Retrieves details of an autonomous system by ASN
+- `get_ip_details`: Provides information about a specific IP address
+- `get_traffic_anomalies`: Lists traffic anomalies (filterable by AS, location, start date, and end date)
+
+This MCP server is still a work in progress, and we plan to add more tools in the future.
+
 ## Getting Started
 
-- Set secrets via Wrangler (ask in the `Cloudflare's Own MCP Servers` internal channel to get credentials)
+#### Secrets
+
+Set secrets via Wrangler (ask in the `Cloudflare's Own MCP Servers` internal channel to get credentials)
 
 ```bash
-wrangler secret put CLOUDFLARE_CLIENT_ID
-wrangler secret put CLOUDFLARE_CLIENT_SECRET
+npx wrangler secret put CLOUDFLARE_CLIENT_ID -e <ENVIRONMENT>
+npx wrangler secret put CLOUDFLARE_CLIENT_SECRET -e <ENVIRONMENT>
 ```
 
 #### Set up a KV namespace
 
-- Create the KV namespace:
-  `wrangler kv:namespace create "OAUTH_KV"`
-- Update the Wrangler file with the KV ID
+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
-` wrangler deploy`
+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):
 
 ```
 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
+   ```
+
+2. Start the local development server:
+
+   ```bash
+   npx wrangler dev
+   ```
+
+3. To test locally, open Inspector, and connect to `http://localhost:8788/sse`.
+Once you follow the prompts, you'll be able to "List Tools".

apps/radar/src/index.ts

@@ -3,10 +3,15 @@ import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
 import { McpAgent } from 'agents/mcp'
 import { env } from 'cloudflare:workers'
 
-import { createAuthHandlers, handleTokenExchangeCallback, } from '@repo/mcp-common/src/cloudflare-oauth-handler'
+import {
+	createAuthHandlers,
+	handleTokenExchangeCallback,
+} from '@repo/mcp-common/src/cloudflare-oauth-handler'
 
 import { registerRadarTools } from './tools/radar'
 
+// TODO import { registerUrlScannerTools } from "./tools/url-scanner";
+
 // Context from the auth process, encrypted & stored in the auth token
 // and provided to the DurableMCP as this.props
 export type Props = {
@@ -17,7 +22,7 @@ export type State = never
 
 export class RadarMCP extends McpAgent<Env, State, Props> {
 	server = new McpServer({
-		name: 'Remote MCP Server with Cloudflare Radar Data',
+		name: 'Cloudflare Radar Remote MCP Server',
 		version: '1.0.0',
 	})
 
@@ -30,6 +35,7 @@ export class RadarMCP extends McpAgent<Env, State, Props> {
 
 	async init() {
 		registerRadarTools(this)
+		// TODO registerUrlScannerTools(this)
 	}
 }
 

apps/radar/src/tools/radar.ts

@@ -9,11 +9,12 @@ import {
 	IpParam,
 	SingleLocationParam,
 } from '../types/radar'
-import type { RadarMCP } from "../index";
+
+import type { RadarMCP } from '../index'
 
 export function registerRadarTools(agent: RadarMCP) {
 	agent.server.tool(
-		'radar_ases_list',
+		'list_autonomous_systems',
 		'List Autonomous Systems',
 		{
 			limit: PaginationLimitParam,
@@ -55,7 +56,7 @@ export function registerRadarTools(agent: RadarMCP) {
 	)
 
 	agent.server.tool(
-		'radar_as_details',
+		'get_as_details',
 		'Get Autonomous System details by ASN',
 		{
 			asn: AsnParam,
@@ -89,7 +90,7 @@ export function registerRadarTools(agent: RadarMCP) {
 	)
 
 	agent.server.tool(
-		'radar_ip_details',
+		'get_ip_details',
 		'Get IP address information',
 		{
 			ip: IpParam,
@@ -123,7 +124,7 @@ export function registerRadarTools(agent: RadarMCP) {
 	)
 
 	agent.server.tool(
-		'radar_get_traffic_anomalies',
+		'get_traffic_anomalies',
 		'Get traffic anomalies',
 		{
 			limit: PaginationLimitParam,

apps/radar/src/tools/url-scanner.ts

@@ -0,0 +1,44 @@
+import { getCloudflareClient } from '@repo/mcp-common/src/cloudflare-api'
+
+import { UrlParam } from '../types/url-scanner'
+
+import type { RadarMCP } from '../index'
+
+export function registerUrlScannerTools(agent: RadarMCP) {
+	agent.server.tool(
+		'scan_url',
+		'Submit a URL to scan',
+		{
+			url: UrlParam,
+		},
+		async ({ url }) => {
+			try {
+				const accountId = '' // TODO agent.getActiveAccountId()
+				const client = getCloudflareClient(agent.props.accessToken)
+				const scanId = await client.urlScanner.scans.create({ account_id: accountId, url })
+
+				// TODO get scan...
+
+				return {
+					content: [
+						{
+							type: 'text',
+							text: JSON.stringify({
+								result: scanId,
+							}),
+						},
+					],
+				}
+			} catch (error) {
+				return {
+					content: [
+						{
+							type: 'text',
+							text: `Error scanning URL: ${error instanceof Error && error.message}`,
+						},
+					],
+				}
+			}
+		}
+	)
+}

apps/radar/src/types/url-scanner.ts

@@ -0,0 +1,6 @@
+/**
+ * This file contains the validators for the URL scanner tools.
+ */
+import { z } from 'zod'
+
+export const UrlParam = z.string().url()

apps/radar/wrangler.jsonc

@@ -55,7 +55,7 @@
 			"kv_namespaces": [
 				{
 					"binding": "OAUTH_KV",
-					"id": "a6ad24203a244d248f2fe1acfeb7b3a3"
+					"id": "51342186c2f54c1d82946ffc35e74143"
 				}
 			],
 			"vars": {
@@ -77,7 +77,7 @@
 			"kv_namespaces": [
 				{
 					"binding": "OAUTH_KV",
-					"id": "753f27a19ef94d7dbd49de05588ca890"
+					"id": "5193d970c2cb43a28cc38d4d839b102e"
 				}
 			],
 			"vars": {