Function serializeIntegrationSchema

apps/sim/lib/copilot/vfs/serializers.ts:717–768

(tool: ToolConfig)

 * Serialize an integration/tool schema for VFS components/integrations/{service}/{operation}.json
 */
export function serializeIntegrationSchema(tool: ToolConfig): string {
  const hostedApiKeyParam = isHosted && tool.hosting ? tool.hosting.apiKeyParam : null

  return JSON.stringify(
    {
      // The full registry id is the agent-callable id (deferred tools are sent
      // with this exact id; no stripping). Surface it verbatim so "copy the id
      // field and load it" matches the callable tool and the block's tools.access.
      id: tool.id,
      name: tool.name,
      description: getCopilotToolDescription(tool, { isHosted }),
      version: tool.version,
      oauth: tool.oauth
        ? { required: tool.oauth.required, provider: tool.oauth.provider }
        : undefined,
      params: tool.params
        ? {
            ...Object.fromEntries(
              Object.entries(tool.params)
                .filter(([key, val]) => val != null && key !== hostedApiKeyParam)
                .map(([key, val]) => [
                  key,
                  {
                    type: val.type,
                    required: val.required,
                    description: val.description,
                    default: val.default,
                  },
                ])
            ),
            ...(tool.oauth?.required && {
              credentialId: {
                type: 'string',
                required: false,
                description:
                  'Credential ID to use for this OAuth tool call. For Copilot/Superagent execution, pass this explicitly. Get valid IDs from environment/credentials.json.',
              },
            }),
          }
        : undefined,
      outputs: tool.outputs
        ? Object.fromEntries(
            Object.entries(tool.outputs)
              .filter(([, val]) => val != null)
              .map(([key, val]) => [key, { type: val.type, description: val.description }])
          )
        : undefined,
    },
    null,
    2
  )
}

/**
 * Serialize a trigger schema for VFS components/triggers/{provider}/{id}.json