mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-06 03:00:16 -04:00
* feat(timeouts): execution timeout limits * fix type issues * add to docs * update stale exec cleanup route * update more callsites * update tests * address bugbot comments * remove import expression * support streaming and async paths' * fix streaming path * add hitl and workflow handler * make sync path match * consolidate * timeout errors * validation errors typed * import order * Merge staging into feat/timeout-lims Resolved conflicts: - stt/route.ts: Keep both execution timeout and security imports - textract/parse/route.ts: Keep both execution timeout and validation imports - use-workflow-execution.ts: Keep cancellation console entry from feature branch - input-validation.ts: Remove server functions (moved to .server.ts in staging) - tools/index.ts: Keep execution timeout, use .server import for security * make run from block consistent * revert console update change * fix subflow errors * clean up base 64 cache correctly * update docs * consolidate workflow execution and run from block hook code * remove unused constant * fix cleanup base64 sse * fix run from block tracespan
283 lines
9.2 KiB
TypeScript
283 lines
9.2 KiB
TypeScript
import { createLogger } from '@sim/logger'
|
|
import type { NextRequest } from 'next/server'
|
|
import { getHighestPrioritySubscription } from '@/lib/billing/core/plan'
|
|
import { getExecutionTimeout } from '@/lib/core/execution-limits'
|
|
import type { SubscriptionPlan } from '@/lib/core/rate-limiter/types'
|
|
import { getParsedBody, withMcpAuth } from '@/lib/mcp/middleware'
|
|
import { mcpService } from '@/lib/mcp/service'
|
|
import type { McpTool, McpToolCall, McpToolResult } from '@/lib/mcp/types'
|
|
import {
|
|
categorizeError,
|
|
createMcpErrorResponse,
|
|
createMcpSuccessResponse,
|
|
validateStringParam,
|
|
} from '@/lib/mcp/utils'
|
|
|
|
const logger = createLogger('McpToolExecutionAPI')
|
|
|
|
export const dynamic = 'force-dynamic'
|
|
|
|
interface SchemaProperty {
|
|
type: 'string' | 'number' | 'boolean' | 'object' | 'array'
|
|
description?: string
|
|
enum?: unknown[]
|
|
format?: string
|
|
items?: SchemaProperty
|
|
properties?: Record<string, SchemaProperty>
|
|
}
|
|
|
|
interface ToolExecutionResult {
|
|
success: boolean
|
|
output?: McpToolResult
|
|
error?: string
|
|
}
|
|
|
|
function hasType(prop: unknown): prop is SchemaProperty {
|
|
return typeof prop === 'object' && prop !== null && 'type' in prop
|
|
}
|
|
|
|
/**
|
|
* POST - Execute a tool on an MCP server
|
|
*/
|
|
export const POST = withMcpAuth('read')(
|
|
async (request: NextRequest, { userId, workspaceId, requestId }) => {
|
|
try {
|
|
const body = getParsedBody(request) || (await request.json())
|
|
|
|
logger.info(`[${requestId}] MCP tool execution request received`, {
|
|
hasAuthHeader: !!request.headers.get('authorization'),
|
|
authHeaderType: request.headers.get('authorization')?.substring(0, 10),
|
|
bodyKeys: Object.keys(body),
|
|
serverId: body.serverId,
|
|
toolName: body.toolName,
|
|
hasWorkflowId: !!body.workflowId,
|
|
workflowId: body.workflowId,
|
|
userId: userId,
|
|
})
|
|
|
|
const { serverId, toolName, arguments: rawArgs } = body
|
|
const args = rawArgs || {}
|
|
|
|
const serverIdValidation = validateStringParam(serverId, 'serverId')
|
|
if (!serverIdValidation.isValid) {
|
|
logger.warn(`[${requestId}] Invalid serverId: ${serverId}`)
|
|
return createMcpErrorResponse(new Error(serverIdValidation.error), 'Invalid serverId', 400)
|
|
}
|
|
|
|
const toolNameValidation = validateStringParam(toolName, 'toolName')
|
|
if (!toolNameValidation.isValid) {
|
|
logger.warn(`[${requestId}] Invalid toolName: ${toolName}`)
|
|
return createMcpErrorResponse(new Error(toolNameValidation.error), 'Invalid toolName', 400)
|
|
}
|
|
|
|
logger.info(
|
|
`[${requestId}] Executing tool ${toolName} on server ${serverId} for user ${userId} in workspace ${workspaceId}`
|
|
)
|
|
|
|
let tool: McpTool | null = null
|
|
try {
|
|
if (body.toolSchema) {
|
|
tool = {
|
|
name: toolName,
|
|
inputSchema: body.toolSchema,
|
|
serverId: serverId,
|
|
serverName: 'provided-schema',
|
|
} as McpTool
|
|
logger.debug(`[${requestId}] Using provided schema for ${toolName}, skipping discovery`)
|
|
} else {
|
|
const tools = await mcpService.discoverServerTools(userId, serverId, workspaceId)
|
|
tool = tools.find((t) => t.name === toolName) ?? null
|
|
|
|
if (!tool) {
|
|
return createMcpErrorResponse(
|
|
new Error(
|
|
`Tool ${toolName} not found on server ${serverId}. Available tools: ${tools.map((t) => t.name).join(', ')}`
|
|
),
|
|
'Tool not found',
|
|
404
|
|
)
|
|
}
|
|
}
|
|
|
|
if (tool.inputSchema?.properties) {
|
|
for (const [paramName, paramSchema] of Object.entries(tool.inputSchema.properties)) {
|
|
const schema = paramSchema as any
|
|
const value = args[paramName]
|
|
|
|
if (value === undefined || value === null) {
|
|
continue
|
|
}
|
|
|
|
if (
|
|
(schema.type === 'number' || schema.type === 'integer') &&
|
|
typeof value === 'string'
|
|
) {
|
|
const numValue =
|
|
schema.type === 'integer' ? Number.parseInt(value) : Number.parseFloat(value)
|
|
if (!Number.isNaN(numValue)) {
|
|
args[paramName] = numValue
|
|
}
|
|
} else if (schema.type === 'boolean' && typeof value === 'string') {
|
|
if (value.toLowerCase() === 'true') {
|
|
args[paramName] = true
|
|
} else if (value.toLowerCase() === 'false') {
|
|
args[paramName] = false
|
|
}
|
|
} else if (schema.type === 'array' && typeof value === 'string') {
|
|
const stringValue = value.trim()
|
|
if (stringValue) {
|
|
try {
|
|
const parsed = JSON.parse(stringValue)
|
|
if (Array.isArray(parsed)) {
|
|
args[paramName] = parsed
|
|
} else {
|
|
args[paramName] = [parsed]
|
|
}
|
|
} catch {
|
|
if (stringValue.includes(',')) {
|
|
args[paramName] = stringValue
|
|
.split(',')
|
|
.map((item) => item.trim())
|
|
.filter((item) => item)
|
|
} else {
|
|
args[paramName] = [stringValue]
|
|
}
|
|
}
|
|
} else {
|
|
args[paramName] = []
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} catch (error) {
|
|
logger.warn(
|
|
`[${requestId}] Failed to discover tools for validation, proceeding anyway:`,
|
|
error
|
|
)
|
|
}
|
|
|
|
if (tool) {
|
|
const validationError = validateToolArguments(tool, args)
|
|
if (validationError) {
|
|
logger.warn(`[${requestId}] Tool validation failed: ${validationError}`)
|
|
return createMcpErrorResponse(
|
|
new Error(`Invalid arguments for tool ${toolName}: ${validationError}`),
|
|
'Invalid tool arguments',
|
|
400
|
|
)
|
|
}
|
|
}
|
|
|
|
const toolCall: McpToolCall = {
|
|
name: toolName,
|
|
arguments: args,
|
|
}
|
|
|
|
const userSubscription = await getHighestPrioritySubscription(userId)
|
|
const executionTimeout = getExecutionTimeout(
|
|
userSubscription?.plan as SubscriptionPlan | undefined,
|
|
'sync'
|
|
)
|
|
|
|
const result = await Promise.race([
|
|
mcpService.executeTool(userId, serverId, toolCall, workspaceId),
|
|
new Promise<never>((_, reject) =>
|
|
setTimeout(() => reject(new Error('Tool execution timeout')), executionTimeout)
|
|
),
|
|
])
|
|
|
|
const transformedResult = transformToolResult(result)
|
|
|
|
if (result.isError) {
|
|
logger.warn(`[${requestId}] Tool execution returned error for ${toolName} on ${serverId}`)
|
|
return createMcpErrorResponse(
|
|
transformedResult,
|
|
transformedResult.error || 'Tool execution failed',
|
|
400
|
|
)
|
|
}
|
|
logger.info(`[${requestId}] Successfully executed tool ${toolName} on server ${serverId}`)
|
|
|
|
try {
|
|
const { PlatformEvents } = await import('@/lib/core/telemetry')
|
|
PlatformEvents.mcpToolExecuted({
|
|
serverId,
|
|
toolName,
|
|
status: 'success',
|
|
workspaceId,
|
|
})
|
|
} catch {
|
|
// Telemetry failure is non-critical
|
|
}
|
|
|
|
return createMcpSuccessResponse(transformedResult)
|
|
} catch (error) {
|
|
logger.error(`[${requestId}] Error executing MCP tool:`, error)
|
|
|
|
const { message, status } = categorizeError(error)
|
|
return createMcpErrorResponse(new Error(message), message, status)
|
|
}
|
|
}
|
|
)
|
|
|
|
function validateToolArguments(tool: McpTool, args: Record<string, unknown>): string | null {
|
|
if (!tool.inputSchema) {
|
|
return null
|
|
}
|
|
|
|
const schema = tool.inputSchema
|
|
|
|
if (schema.required && Array.isArray(schema.required)) {
|
|
for (const requiredProp of schema.required) {
|
|
if (!(requiredProp in (args || {}))) {
|
|
return `Missing required property: ${requiredProp}`
|
|
}
|
|
}
|
|
}
|
|
|
|
if (schema.properties && args) {
|
|
for (const [propName, propSchema] of Object.entries(schema.properties)) {
|
|
const propValue = args[propName]
|
|
if (propValue !== undefined && hasType(propSchema)) {
|
|
const expectedType = propSchema.type
|
|
const actualType = typeof propValue
|
|
|
|
if (expectedType === 'string' && actualType !== 'string') {
|
|
return `Property ${propName} must be a string`
|
|
}
|
|
if (expectedType === 'number' && actualType !== 'number') {
|
|
return `Property ${propName} must be a number`
|
|
}
|
|
if (expectedType === 'boolean' && actualType !== 'boolean') {
|
|
return `Property ${propName} must be a boolean`
|
|
}
|
|
if (
|
|
expectedType === 'object' &&
|
|
(actualType !== 'object' || propValue === null || Array.isArray(propValue))
|
|
) {
|
|
return `Property ${propName} must be an object`
|
|
}
|
|
if (expectedType === 'array' && !Array.isArray(propValue)) {
|
|
return `Property ${propName} must be an array`
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return null
|
|
}
|
|
|
|
function transformToolResult(result: McpToolResult): ToolExecutionResult {
|
|
if (result.isError) {
|
|
return {
|
|
success: false,
|
|
error: result.content?.[0]?.text || 'Tool execution failed',
|
|
}
|
|
}
|
|
|
|
return {
|
|
success: true,
|
|
output: result,
|
|
}
|
|
}
|