Linked API MCP

Instructions

Implementation Reference

• src/tools/execute-custom-workflow.ts:7-28 (handler)

  The ExecuteCustomWorkflowTool class defines the tool handler, including name, operation name for LinkedAPI, Zod schema for validation, and the MCP tool definition via getTool().

  export class ExecuteCustomWorkflowTool extends OperationTool<
    TWorkflowDefinition,
    TWorkflowCompletion
  > {
    public override readonly name = 'execute_custom_workflow';
    public override readonly operationName = OPERATION_NAME.customWorkflow;
    protected override readonly schema = z.object({
      definition: z.any(),
    });
  
    public override getTool(): Tool {
      return {
        name: this.name,
        description: 'Execute a custom workflow definition',
        inputSchema: {
          type: 'object',
          properties: { definition: { type: 'object' } },
          required: ['definition'],
        },
      };
    }
  }

• src/tools/execute-custom-workflow.ts:13-15 (schema)

  Zod schema for input validation: accepts any object under 'definition' key.

  protected override readonly schema = z.object({
    definition: z.any(),
  });

• src/linked-api-tools.ts:36-66 (registration)

  The ExecuteCustomWorkflowTool is instantiated and registered in the LinkedApiTools class constructor, added to the array of available tools used by the MCP server.

    // Standard tools
    new SendMessageTool(progressCallback),
    new GetConversationTool(progressCallback),
    new CheckConnectionStatusTool(progressCallback),
    new RetrieveConnectionsTool(progressCallback),
    new SendConnectionRequestTool(progressCallback),
    new WithdrawConnectionRequestTool(progressCallback),
    new RetrievePendingRequestsTool(progressCallback),
    new RemoveConnectionTool(progressCallback),
    new SearchCompaniesTool(progressCallback),
    new SearchPeopleTool(progressCallback),
    new FetchCompanyTool(progressCallback),
    new FetchPersonTool(progressCallback),
    new FetchPostTool(progressCallback),
    new ReactToPostTool(progressCallback),
    new CommentOnPostTool(progressCallback),
    new CreatePostTool(progressCallback),
    new RetrieveSSITool(progressCallback),
    new RetrievePerformanceTool(progressCallback),
    // Sales Navigator tools
    new NvSendMessageTool(progressCallback),
    new NvGetConversationTool(progressCallback),
    new NvSearchCompaniesTool(progressCallback),
    new NvSearchPeopleTool(progressCallback),
    new NvFetchCompanyTool(progressCallback),
    new NvFetchPersonTool(progressCallback),
    // Other tools
    new ExecuteCustomWorkflowTool(progressCallback),
    new GetWorkflowResultTool(progressCallback),
    new GetApiUsageTool(progressCallback),
  ];

• src/utils/linked-api-tool.ts:36-58 (helper)

  Base class OperationTool provides the core execute logic by mapping the tool's operationName to a LinkedAPI operation and executing it with progress handling.

  export abstract class OperationTool<TParams, TResult> extends LinkedApiTool<TParams, TResult> {
    public abstract readonly operationName: TOperationName;
  
    public override execute({
      linkedapi,
      args,
      workflowTimeout,
      progressToken,
    }: {
      linkedapi: LinkedApi;
      args: TParams;
      workflowTimeout: number;
      progressToken?: string | number;
    }): Promise<TMappedResponse<TResult>> {
      const operation = linkedapi.operations.find(
        (operation) => operation.operationName === this.operationName,
      )! as Operation<TParams, TResult>;
      return executeWithProgress(this.progressCallback, operation, workflowTimeout, {
        params: args,
        progressToken,
      });
    }
  }

• src/linked-api-server.ts:22-24 (registration)

  The LinkedApiMCPServer exposes all registered tools (including execute_custom_workflow) via getTools(), which calls each tool's getTool() to provide MCP tool definitions.

  public getTools(): Tool[] {
    return this.tools.tools.map((tool) => tool.getTool());
  }