Skip to content

feat: CASB MCP Improved pagination support and typing on API calls. #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: CASB MCP Improved pagination support and typing on API calls. #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa4a1b5
feat: Improved pagination support and typing on API calls.
frankmeszaros May 1, 2025
6601d5a
Merge branch 'main' of https://github.com/cloudflare/mcp-server-cloud…
frankmeszaros May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 105 additions & 53 deletions apps/cloudflare-one-casb/src/tools/integrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,231 +16,283 @@ import {
assetCategoryVendorParam,
} from '@repo/mcp-common/src/schemas/cf1-integrations'

import type { zReturnedAssetResult } from '@repo/mcp-common/src/schemas/cf1-integrations'
import type { ToolDefinition } from '@repo/mcp-common/src/types/tools'
import type { CASBMCP } from '../index'

const PAGE_SIZE = 3

const integrationIdParam = z.string().describe('The UUID of the integration to analyze')
const assetSearchTerm = z.string().describe('The search keyword for assets')
const assetIdParam = z.string().describe('The UUID of the asset to analyze')
const assetCategoryIdParam = z.string().describe('The UUID of the asset category to analyze')

const paginationParams = z
.object({
page: z.number().optional().describe('Page number for pagination'),
pageSize: z.number().optional().describe('Number of items per page'),
})
.optional()

const assetLite = ({ fields: _, integration, ...asset }: zReturnedAssetResult) => ({
...asset,
integration: {
id: integration.id,
name: integration.name,
},
})

const toolDefinitions: Array<ToolDefinition<any>> = [
{
name: 'integration_by_id',
description: 'Analyze Cloudflare One Integration by ID',
params: { integrationIdParam },
params: { integrationIdParam, paginationParams },
handler: async ({
integrationIdParam,
accountId,
apiToken,
paginationParams = {},
}: {
integrationIdParam: string
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { integration } = await handleIntegrationById({
integrationIdParam,
accountId,
apiToken,
...paginationParams,
})
return { integration }
},
},
{
name: 'integrations_list',
description: 'List all Cloudflare One Integrations in a given account',
params: {},
handler: async ({ accountId, apiToken }: { accountId: string; apiToken: string }) => {
const { integrations } = await handleIntegrations({ accountId, apiToken })
return { integrations }
params: { paginationParams },
handler: async ({
accountId,
apiToken,
paginationParams = {},
}: {
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { integrations, result_info } = await handleIntegrations({
accountId,
apiToken,
...paginationParams,
})
return { integrations, result_info }
},
},
{
name: 'assets_search',
description: 'Search Assets by keyword',
params: { assetSearchTerm },
params: { assetSearchTerm, paginationParams },
handler: async ({
assetSearchTerm,
accountId,
apiToken,
paginationParams = {},
}: {
assetSearchTerm: string
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { assets } = await handleAssetsSearch({
const { assets, result_info } = await handleAssetsSearch({
accountId,
apiToken,
searchTerm: assetSearchTerm,
pageSize: PAGE_SIZE,
...paginationParams,
})
return { assets }
return { assets: assets.map(assetLite), result_info }
},
},
{
name: 'asset_by_id',
description: 'Search Assets by ID',
params: { assetIdParam },
params: { assetIdParam, paginationParams },
handler: async ({
assetIdParam,
accountId,
apiToken,
paginationParams = {},
}: {
assetIdParam: string
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { asset } = await handleAssetById({
accountId,
apiToken,
assetId: assetIdParam,
...paginationParams,
})
return { asset }
},
},
{
name: 'assets_by_integration_id',
description: 'Search Assets by Integration ID',
params: { integrationIdParam },
params: { integrationIdParam, paginationParams },
handler: async ({
integrationIdParam,
accountId,
apiToken,
paginationParams = {},
}: {
integrationIdParam: string
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { assets } = await handleAssetsByIntegrationId({
const { assets, result_info } = await handleAssetsByIntegrationId({
accountId,
apiToken,
integrationId: integrationIdParam,
pageSize: PAGE_SIZE,
...paginationParams,
})
return { assets }
return { assets: assets.map(assetLite), result_info }
},
},
{
name: 'assets_by_category_id',
description: 'Search Assets by Asset Category ID',
params: { assetCategoryIdParam },
params: { assetCategoryIdParam, paginationParams },
handler: async ({
assetCategoryIdParam,
accountId,
apiToken,
paginationParams = {},
}: {
assetCategoryIdParam: string
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { assets } = await handleAssetsByAssetCategoryId({
const { assets, result_info } = await handleAssetsByAssetCategoryId({
accountId,
apiToken,
categoryId: assetCategoryIdParam,
pageSize: PAGE_SIZE,
...paginationParams,
})
return { assets }
return { assets: assets.map(assetLite), result_info }
},
},
{
name: 'assets_list',
description: 'Paginated list of Assets',
params: {},
handler: async ({ accountId, apiToken }: { accountId: string; apiToken: string }) => {
const { assets } = await handleAssets({
params: { paginationParams },
handler: async ({
accountId,
apiToken,
paginationParams = {},
}: {
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) => {
const { assets, result_info } = await handleAssets({
accountId,
apiToken,
pageSize: PAGE_SIZE,
...paginationParams,
})
return { assets }
return { assets: assets.map(assetLite), result_info }
},
},
{
name: 'asset_categories_list',
description: 'List Asset Categories',
params: {},
handler: async ({ accountId, apiToken }: { accountId: string; apiToken: string }) => {
const { categories } = await handleAssetCategories({
params: { paginationParams },
handler: async ({
accountId,
apiToken,
paginationParams = {},
}: {
accountId: string
apiToken: string
paginationParams?: { page?: number; pageSize?: number }
}) =>
await handleAssetCategories({
accountId,
apiToken,
})
return { categories }
},
...paginationParams,
}),
},
{
name: 'asset_categories_by_vendor',
description: 'List asset categories by vendor',
params: { assetCategoryVendorParam },
params: { assetCategoryVendorParam, paginationParams },
handler: async ({
assetCategoryVendorParam,
accountId,
apiToken,
paginationParams = {},
}: {
assetCategoryVendorParam: string
accountId: string
apiToken: string
}) => {
const { categories } = await handleAssetCategories({
paginationParams?: { page?: number; pageSize?: number }
}) =>
await handleAssetCategories({
accountId,
apiToken,
vendor: assetCategoryVendorParam,
})
return { categories }
},
...paginationParams,
}),
},
{
name: 'asset_categories_by_type',
description: 'Search Asset Categories by type',
params: { assetCategoryTypeParam },
params: { assetCategoryTypeParam, paginationParams },
handler: async ({
assetCategoryTypeParam,
accountId,
apiToken,
paginationParams = {},
}: {
assetCategoryTypeParam?: string
accountId: string
apiToken: string
}) => {
const { categories } = await handleAssetCategories({
paginationParams?: { page?: number; pageSize?: number }
}) =>
await handleAssetCategories({
accountId,
apiToken,
type: assetCategoryTypeParam,
})
return { categories }
},
...paginationParams,
}),
},
{
name: 'asset_categories_by_vendor_and_type',
description: 'Search Asset Categories by vendor and type',
params: { assetCategoryTypeParam, assetCategoryVendorParam },
params: { assetCategoryTypeParam, assetCategoryVendorParam, paginationParams },
handler: async ({
assetCategoryTypeParam,
assetCategoryVendorParam,
accountId,
apiToken,
paginationParams = {},
}: {
assetCategoryTypeParam?: string
assetCategoryVendorParam: string
accountId: string
apiToken: string
}) => {
const { categories } = await handleAssetCategories({
paginationParams?: { page?: number; pageSize?: number }
}) =>
await handleAssetCategories({
accountId,
apiToken,
type: assetCategoryTypeParam,
vendor: assetCategoryVendorParam,
})
return { categories }
},
...paginationParams,
}),
},
]

/**
* Registers the logs analysis tool with the MCP server
* @param agent The MCP server instance
*/
export function registerIntegrationsTools(agent: CASBMCP) {
toolDefinitions.forEach(({ name, description, params, handler }) => {
agent.server.tool(name, description, params, withAccountCheck(agent, handler))
Expand Down
Loading
Loading