get_campaign
Retrieve detailed information about a specific email campaign using its unique identifier to monitor performance and manage marketing activities.
Instructions
Get details of a specific campaign
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaign_id | Yes | Campaign ID |
Implementation Reference
- src/handlers/tool-executor.ts:241-249 (handler)Handler function that validates input, makes API request to /campaigns/{campaign_id}, and returns formatted response.
case 'get_campaign': { if (!args?.campaign_id) { throw new McpError(ErrorCode.InvalidParams, 'campaign_id is required'); } const result = await makeInstantlyRequest(`/campaigns/${args.campaign_id}`, {}, apiKey); return createMCPResponse(result); } - src/tools/campaign-tools.ts:58-70 (schema)MCP tool definition including name, description, annotations, and input schema for get_campaign.
{ name: 'get_campaign', title: 'Get Campaign', description: 'Get campaign details: config, sequences, schedules, sender accounts, tracking, status', annotations: { readOnlyHint: true }, inputSchema: { type: 'object', properties: { campaign_id: { type: 'string', description: 'Campaign UUID' } }, required: ['campaign_id'] } }, - src/validation.ts:314-316 (schema)Zod schema for validating get_campaign input parameters.
export const GetCampaignSchema = z.object({ campaign_id: z.string().min(1, { message: 'Campaign ID cannot be empty' }) }); - src/validation.ts:813-813 (registration)Registration of the get_campaign validator in the TOOL_VALIDATORS mapping.
'get_campaign': validateGetCampaignData, - src/validation.ts:701-702 (helper)Validation helper function that applies the GetCampaignSchema to input arguments.
export function validateGetCampaignData(args: unknown): z.infer<typeof GetCampaignSchema> { return validateWithSchema(GetCampaignSchema, args, 'get_campaign');