added zone_list / zone_details tools (#91)

Author: cf-ypark

packages/mcp-common/src/api/zone.ts

@@ -0,0 +1,61 @@
+import type { Cloudflare } from 'cloudflare'
+
+export interface ZoneListParams {
+	client: Cloudflare
+	accountId: string
+	page?: number
+	perPage?: number
+	direction?: 'asc' | 'desc'
+	match?: 'any' | 'all'
+	name?: string
+	status?: string
+	order?: string
+}
+
+/**
+ * Lists zones under a Cloudflare account
+ * @see https://developers.cloudflare.com/api/resources/zones/methods/list/
+ */
+export async function handleZonesList({
+	client,
+	accountId,
+	page = 1,
+	perPage = 50,
+	direction = 'desc',
+	match = 'all',
+	name,
+	status,
+	order = 'name',
+}: ZoneListParams) {
+	// Build query parameters
+	const query: Record<string, string | number> = {
+		page,
+		per_page: perPage,
+		direction,
+		match,
+		account_id: accountId,
+	}
+
+	// Only add these parameters if they're defined and not empty strings
+	if (name) {
+		query.name = name
+	}
+
+	if (status) {
+		query.status = status
+	}
+
+	if (order) {
+		query.order = order
+	}
+
+	try {
+		// Use the zones.list method from the Cloudflare client
+		const response = await client.zones.list({ query })
+		return response.result
+	} catch (error) {
+		throw new Error(
+			`Failed to list zones: ${error instanceof Error ? error.message : String(error)}`
+		)
+	}
+}

packages/mcp-common/src/tools/zone.ts

@@ -0,0 +1,129 @@
+import { z } from 'zod'
+
+import { handleZonesList } from '../api/zone'
+import { getCloudflareClient } from '../cloudflare-api'
+import { type CloudflareMcpAgent } from '../types/cloudflare-mcp-agent'
+
+export function registerZoneTools(agent: CloudflareMcpAgent) {
+	// Tool to list all zones under an account
+	agent.server.tool(
+		'zones_list',
+		'List all zones under a Cloudflare account',
+		{
+			name: z.string().optional().describe('Filter zones by name'),
+			status: z
+				.string()
+				.optional()
+				.describe(
+					'Filter zones by status (active, pending, initializing, moved, deleted, deactivated, read only)'
+				),
+			page: z.number().min(1).default(1).describe('Page number for pagination'),
+			perPage: z.number().min(5).max(1000).default(50).describe('Number of zones per page'),
+			order: z
+				.string()
+				.default('name')
+				.describe('Field to order results by (name, status, account_name)'),
+			direction: z
+				.enum(['asc', 'desc'])
+				.default('desc')
+				.describe('Direction to order results (asc, desc)'),
+		},
+		async (params) => {
+			const accountId = await agent.getActiveAccountId()
+			if (!accountId) {
+				return {
+					content: [
+						{
+							type: 'text',
+							text: 'No currently active accountId. Try listing your accounts (accounts_list) and then setting an active account (set_active_account)',
+						},
+					],
+				}
+			}
+
+			try {
+				const { page = 1, perPage = 50 } = params
+
+				const zones = await handleZonesList({
+					client: getCloudflareClient(agent.props.accessToken),
+					accountId,
+					...params,
+				})
+
+				return {
+					content: [
+						{
+							type: 'text',
+							text: JSON.stringify({
+								zones,
+								count: zones.length,
+								page,
+								perPage,
+								accountId,
+							}),
+						},
+					],
+				}
+			} catch (error) {
+				return {
+					content: [
+						{
+							type: 'text',
+							text: `Error listing zones: ${error instanceof Error ? error.message : String(error)}`,
+						},
+					],
+				}
+			}
+		}
+	)
+
+	// Tool to get zone details by ID
+	agent.server.tool(
+		'zone_details',
+		'Get details for a specific Cloudflare zone',
+		{
+			zoneId: z.string().describe('The ID of the zone to get details for'),
+		},
+		async (params) => {
+			const accountId = await agent.getActiveAccountId()
+			if (!accountId) {
+				return {
+					content: [
+						{
+							type: 'text',
+							text: 'No currently active accountId. Try listing your accounts (accounts_list) and then setting an active account (set_active_account)',
+						},
+					],
+				}
+			}
+
+			try {
+				const { zoneId } = params
+				const client = getCloudflareClient(agent.props.accessToken)
+
+				// Use the zones.get method to fetch a specific zone
+				const response = await client.zones.get({ zone_id: zoneId })
+
+				return {
+					content: [
+						{
+							type: 'text',
+							text: JSON.stringify({
+								zone: response,
+							}),
+						},
+					],
+				}
+			} catch (error) {
+				return {
+					content: [
+						{
+							type: 'text',
+							text: `Error fetching zone details: ${error instanceof Error ? error.message : String(error)}`,
+						},
+					],
+				}
+			}
+		}
+	)
+}