@apify/actors-mcp-server 0.1.0 → 0.1.1-beta.0

package/src/actorDefinition.ts

@@ -1,87 +0,0 @@
-import { Ajv } from 'ajv';
-import { ApifyClient } from 'apify-client';
-
-import { log } from './logger.js';
-import type { ActorDefinitionWithDesc, Tool } from './types';
-
-/**
- * Get actor input schema by actor name.
- * First, fetch the actor details to get the default build tag and buildId.
- * Then, fetch the build details and return actorName, description, and input schema.
- * @param {string} actorFullName - The full name of the actor.
- * @returns {Promise<ActorDefinitionWithDesc | null>} - The actor definition with description or null if not found.
- */
-async function fetchActorDefinition(actorFullName: string): Promise<ActorDefinitionWithDesc | null> {
-    if (!process.env.APIFY_TOKEN) {
-        log.error('APIFY_TOKEN is required but not set. Please set it as an environment variable');
-        return null;
-    }
-    const client = new ApifyClient({ token: process.env.APIFY_TOKEN });
-    const actorClient = client.actor(actorFullName);
-
-    try {
-        // Fetch actor details
-        const actor = await actorClient.get();
-        if (!actor) {
-            log.error(`Failed to fetch input schema for actor: ${actorFullName}. Actor not found.`);
-            return null;
-        }
-
-        // fnesveda: The default build is not necessarily tagged, you can specify any build number as default build.
-        // There will be a new API endpoint to fetch a default build.
-        // For now, we'll use the tagged build, it will work for 90% of Actors. Later, we can update this.
-        const tag = actor.defaultRunOptions?.build || '';
-        const buildId = actor.taggedBuilds?.[tag]?.buildId || '';
-
-        if (!buildId) {
-            log.error(`Failed to fetch input schema for actor: ${actorFullName}. Build ID not found.`);
-            return null;
-        }
-        // Fetch build details and return the input schema
-        const buildDetails = await client.build(buildId).get();
-        if (buildDetails?.actorDefinition) {
-            const actorDefinitions = buildDetails?.actorDefinition as ActorDefinitionWithDesc;
-            actorDefinitions.description = actor.description || '';
-            actorDefinitions.name = actorFullName;
-            return actorDefinitions;
-        }
-        return null;
-    } catch (error) {
-        log.error(`Failed to fetch input schema for actor: ${actorFullName} with error ${error}.`);
-        return null;
-    }
-}
-
-/**
- * Fetches actor input schemas by actor full names and creates MCP tools.
- *
- * This function retrieves the input schemas for the specified actors and compiles them into MCP tools.
- * It uses the AJV library to validate the input schemas.
- *
- * Tool name can't contain /, so it is replaced with _
- *
- * @param {string[]} actors - An array of actor full names.
- * @returns {Promise<Tool[]>} - A promise that resolves to an array of MCP tools.
- */
-export async function getActorsAsTools(actors: string[]): Promise<Tool[]> {
-    // Fetch input schemas in parallel
-    const ajv = new Ajv({ coerceTypes: 'array', strict: false });
-    const results = await Promise.all(actors.map(fetchActorDefinition));
-    const tools = [];
-    for (const result of results) {
-        if (result) {
-            try {
-                tools.push({
-                    name: result.name.replace('/', '_'),
-                    actorName: result.name,
-                    description: result.description,
-                    inputSchema: result.input || {},
-                    ajvValidate: ajv.compile(result.input || {}),
-                });
-            } catch (validationError) {
-                log.error(`Failed to compile AJV schema for actor: ${result.name}. Error: ${validationError}`);
-            }
-        }
-    }
-    return tools;
-}

package/src/const.ts

@@ -1,20 +0,0 @@
-export const SERVER_NAME = 'apify-mcp-server';
-export const SERVER_VERSION = '0.1.0';
-
-export const defaults = {
-    actors: [
-        'apify/instagram-scraper',
-        'apify/rag-web-browser',
-        'lukaskrivka/google-maps-with-contact-details',
-    ],
-};
-
-export const ACTOR_OUTPUT_MAX_CHARS_PER_ITEM = 2_000;
-export const ACTOR_OUTPUT_TRUNCATED_MESSAGE = `Output was truncated because it will not fit into context.`
-    + ` There is no reason to call this tool again!`;
-
-export enum Routes {
-    ROOT = '/',
-    SSE = '/sse',
-    MESSAGE = '/message',
-}

package/src/examples/clientSse.ts

@@ -1,100 +0,0 @@
-/* eslint-disable no-console */
-/**
- * Connect to the MCP server using SSE transport and call a tool.
- * The Actors MCP Server will load default Actors.
- *
- * !!! This example needs to be fixed as it does not work !!!
- */
-
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import { Client } from '@modelcontextprotocol/sdk/client/index.js';
-import { SSEClientTransport } from '@modelcontextprotocol/sdk/client/sse.js';
-import { CallToolResultSchema } from '@modelcontextprotocol/sdk/types.js';
-import dotenv from 'dotenv';
-import { EventSource } from 'eventsource';
-
-// Resolve dirname equivalent in ES module
-const filename = fileURLToPath(import.meta.url);
-const dirname = path.dirname(filename);
-
-dotenv.config({ path: path.resolve(dirname, '../../.env') });
-
-const SERVER_URL = 'https://actors-mcp-server/sse';
-// We need to change forward slash / to underscore _ in the tool name as Anthropic does not allow forward slashes in the tool name
-const SELECTED_TOOL = 'apify_rag-web-browser';
-
-if (!process.env.APIFY_TOKEN) {
-    console.error('APIFY_TOKEN is required but not set in the environment variables.');
-    process.exit(1);
-}
-
-if (typeof globalThis.EventSource === 'undefined') {
-    globalThis.EventSource = EventSource as unknown as typeof globalThis.EventSource;
-}
-
-async function main(): Promise<void> {
-    const transport = new SSEClientTransport(
-        new URL(SERVER_URL),
-        {
-            requestInit: {
-                headers: {
-                    authorization: `Bearer ${process.env.APIFY_TOKEN}`,
-                },
-            },
-            eventSourceInit: {
-                // The EventSource package augments EventSourceInit with a "fetch" parameter.
-                // You can use this to set additional headers on the outgoing request.
-                // Based on this example: https://github.com/modelcontextprotocol/typescript-sdk/issues/118
-                async fetch(input: Request | URL | string, init?: RequestInit) {
-                    const headers = new Headers(init?.headers || {});
-                    headers.set('authorization', `Bearer ${process.env.APIFY_TOKEN}`);
-                    return fetch(input, { ...init, headers });
-                },
-            // We have to cast to "any" to use it, since it's non-standard
-            } as any, // eslint-disable-line @typescript-eslint/no-explicit-any
-        },
-    );
-    const client = new Client(
-        { name: 'example-client', version: '1.0.0' },
-        { capabilities: {} },
-    );
-
-    try {
-        // Connect to the MCP server
-        await client.connect(transport);
-
-        // List available tools
-        const tools = await client.listTools();
-        console.log('Available tools:', tools);
-
-        if (tools.tools.length === 0) {
-            console.log('No tools available');
-            return;
-        }
-
-        const selectedTool = tools.tools.find((tool) => tool.name === SELECTED_TOOL);
-        if (!selectedTool) {
-            console.error(`The specified tool: ${selectedTool} is not available. Exiting.`);
-            return;
-        }
-
-        // Call a tool
-        console.log('Calling actor ...');
-        const result = await client.callTool(
-            { name: SELECTED_TOOL, arguments: { query: 'web browser for Anthropic' } },
-            CallToolResultSchema,
-        );
-        console.log('Tool result:', JSON.stringify(result, null, 2));
-    } catch (error: unknown) {
-        if (error instanceof Error) {
-            console.error('Error:', error.message);
-            console.error(error.stack);
-        } else {
-            console.error('An unknown error occurred:', error);
-        }
-    }
-}
-
-await main();

package/src/examples/clientStdio.ts

@@ -1,85 +0,0 @@
-/* eslint-disable no-console */
-/**
- * Connect to the MCP server using stdio transport and call a tool.
- * This script uses a selected tool without LLM involvement.
- * You need to provide the path to the MCP server and `APIFY_TOKEN` in the `.env` file.
- * You can choose actors to run in the server, for example: `apify/rag-web-browser`.
- */
-
-import { execSync } from 'child_process';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import { Client } from '@modelcontextprotocol/sdk/client/index.js';
-import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
-import { CallToolResultSchema } from '@modelcontextprotocol/sdk/types.js';
-import dotenv from 'dotenv';
-
-// Resolve dirname equivalent in ES module
-const filename = fileURLToPath(import.meta.url);
-const dirname = path.dirname(filename);
-
-dotenv.config({ path: path.resolve(dirname, '../../.env') });
-const SERVER_PATH = path.resolve(dirname, '../../dist/index.js');
-const NODE_PATH = execSync(process.platform === 'win32' ? 'where node' : 'which node').toString().trim();
-
-const TOOLS = 'apify/rag-web-browser,lukaskrivka/google-maps-with-contact-details';
-const SELECTED_TOOL = 'apify_rag-web-browser'; // We need to change / to _ in the tool name
-
-if (!process.env.APIFY_TOKEN) {
-    console.error('APIFY_TOKEN is required but not set in the environment variables.');
-    process.exit(1);
-}
-
-// Create server parameters for stdio connection
-const transport = new StdioClientTransport({
-    command: NODE_PATH,
-    args: [SERVER_PATH, '--actors', TOOLS],
-    env: { APIFY_TOKEN: process.env.APIFY_TOKEN || '' },
-});
-
-// Create a new client instance
-const client = new Client(
-    { name: 'example-client', version: '0.1.0' },
-    { capabilities: {} },
-);
-
-// Main function to run the example client
-async function run() {
-    try {
-        // Connect to the MCP server
-        await client.connect(transport);
-
-        // List available tools
-        const tools = await client.listTools();
-        console.log('Available tools:', tools);
-
-        if (tools.tools.length === 0) {
-            console.log('No tools available');
-            return;
-        }
-
-        // Example: Call the first available tool
-        const selectedTool = tools.tools.find((tool) => tool.name === SELECTED_TOOL);
-
-        if (!selectedTool) {
-            console.error(`The specified tool: ${selectedTool} is not available. Exiting.`);
-            return;
-        }
-
-        // Call a tool
-        console.log('Calling actor ...');
-        const result = await client.callTool(
-            { name: SELECTED_TOOL, arguments: { query: 'web browser for Anthropic' } },
-            CallToolResultSchema,
-        );
-        console.log('Tool result:', JSON.stringify(result));
-    } catch (error) {
-        console.error('Error:', error);
-    }
-}
-
-run().catch((error) => {
-    console.error('Unhandled error:', error);
-    process.exit(1);
-});

package/src/examples/clientStdioChat.ts

@@ -1,227 +0,0 @@
-/* eslint-disable no-console */
-/**
- * Create a simple chat client that connects to the Model Context Protocol server using the stdio transport.
- * Based on the user input, the client sends a query to the MCP server, retrieves results and processes them.
- *
- * You can expect the following output:
- *
- * MCP Client Started!
- * Type your queries or 'quit|q|exit' to exit.
- * You: Find to articles about AI agent and return URLs
- * [internal] Received response from Claude: [{"type":"text","text":"I'll search for information about AI agents
- *   and provide you with a summary."},{"type":"tool_use","id":"tool_01He9TkzQfh2979bbeuxWVqM","name":"search",
- *   "input":{"query":"what are AI agents definition capabilities applications","maxResults":2}}]
- * [internal] Calling tool: {"name":"search","arguments":{"query":"what are AI agents definition ...
- * I can help analyze the provided content about AI agents.
- * This appears to be crawled content from AWS and IBM websites explaining what AI agents are.
- * Let me summarize the key points:
- */
-
-import { execSync } from 'child_process';
-import path from 'path';
-import * as readline from 'readline';
-import { fileURLToPath } from 'url';
-
-import { Anthropic } from '@anthropic-ai/sdk';
-import type { Message, ToolUseBlock, MessageParam } from '@anthropic-ai/sdk/resources/messages';
-import { Client } from '@modelcontextprotocol/sdk/client/index.js';
-import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
-import { CallToolResultSchema } from '@modelcontextprotocol/sdk/types.js';
-import dotenv from 'dotenv';
-
-const filename = fileURLToPath(import.meta.url);
-const dirname = path.dirname(filename);
-
-dotenv.config({ path: path.resolve(dirname, '../../.env') });
-
-const REQUEST_TIMEOUT = 120_000; // 2 minutes
-const MAX_TOKENS = 2048; // Maximum tokens for Claude response
-
-// const CLAUDE_MODEL = 'claude-3-5-sonnet-20241022'; // the most intelligent model
-// const CLAUDE_MODEL = 'claude-3-5-haiku-20241022'; // a fastest model
-const CLAUDE_MODEL = 'claude-3-haiku-20240307'; // a fastest and most compact model for near-instant responsiveness
-const DEBUG = true;
-const DEBUG_SERVER_PATH = path.resolve(dirname, '../../dist/index.js');
-
-const NODE_PATH = execSync('which node').toString().trim();
-
-dotenv.config(); // Load environment variables from .env
-
-export type Tool = {
-    name: string;
-    description: string | undefined;
-    input_schema: unknown;
-}
-
-class MCPClient {
-    private anthropic: Anthropic;
-    private client = new Client(
-        {
-            name: 'example-client',
-            version: '0.1.0',
-        },
-        {
-            capabilities: {}, // Optional capabilities
-        },
-    );
-
-    private tools: Tool[] = [];
-
-    constructor() {
-        this.anthropic = new Anthropic({ apiKey: process.env.ANTHROPIC_API_KEY });
-    }
-
-    /**
-     * Start the server using node and provided server script path.
-     * Connect to the server using stdio transport and list available tools.
-     */
-    async connectToServer(serverArgs: string[]) {
-        const transport = new StdioClientTransport({
-            command: NODE_PATH,
-            args: serverArgs,
-            env: { APIFY_TOKEN: process.env.APIFY_TOKEN || '' },
-        });
-
-        await this.client.connect(transport);
-        const response = await this.client.listTools();
-
-        this.tools = response.tools.map((x) => ({
-            name: x.name,
-            description: x.description,
-            input_schema: x.inputSchema,
-        }));
-        console.log('Connected to server with tools:', this.tools.map((x) => x.name));
-    }
-
-    /**
-     * Process LLM response and check whether it contains any tool calls.
-     * If a tool call is found, call the tool and return the response and save the results to messages with type: user.
-     * If the tools response is too large, truncate it to the limit.
-     */
-    async processMsg(response: Message, messages: MessageParam[]): Promise<MessageParam[]> {
-        for (const content of response.content) {
-            if (content.type === 'text') {
-                messages.push({ role: 'assistant', content: content.text });
-            } else if (content.type === 'tool_use') {
-                await this.handleToolCall(content, messages);
-            }
-        }
-        return messages;
-    }
-
-    /**
-     * Call the tool and return the response.
-     */
-    private async handleToolCall(content: ToolUseBlock, messages: MessageParam[], toolCallCount = 0): Promise<MessageParam[]> {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const params = { name: content.name, arguments: content.input as any };
-        console.log(`[internal] Calling tool (count: ${toolCallCount}): ${JSON.stringify(params)}`);
-        let results;
-        try {
-            results = await this.client.callTool(params, CallToolResultSchema, { timeout: REQUEST_TIMEOUT });
-            if (results.content instanceof Array && results.content.length !== 0) {
-                const text = results.content.map((x) => x.text);
-                messages.push({ role: 'user', content: `Tool result: ${text.join('\n\n')}` });
-            } else {
-                messages.push({ role: 'user', content: `No results retrieved from ${params.name}` });
-            }
-        } catch (error) {
-            messages.push({ role: 'user', content: `Error calling tool: ${params.name}, error: ${error}` });
-        }
-        // Get next response from Claude
-        const nextResponse: Message = await this.anthropic.messages.create({
-            model: CLAUDE_MODEL,
-            max_tokens: MAX_TOKENS,
-            messages,
-            tools: this.tools as any[], // eslint-disable-line @typescript-eslint/no-explicit-any
-        });
-
-        for (const c of nextResponse.content) {
-            if (c.type === 'text') {
-                messages.push({ role: 'assistant', content: c.text });
-            } else if (c.type === 'tool_use' && toolCallCount < 3) {
-                return await this.handleToolCall(c, messages, toolCallCount + 1);
-            }
-        }
-
-        return messages;
-    }
-
-    /**
-     * Process user query by sending it to the server and returning the response.
-     * Also, process any tool calls.
-     */
-    async processQuery(query: string, messages: MessageParam[]): Promise<MessageParam[]> {
-        messages.push({ role: 'user', content: query });
-        const response: Message = await this.anthropic.messages.create({
-            model: CLAUDE_MODEL,
-            max_tokens: MAX_TOKENS,
-            messages,
-            tools: this.tools as any[], // eslint-disable-line @typescript-eslint/no-explicit-any
-        });
-        console.log('[internal] Received response from Claude:', JSON.stringify(response.content));
-        return await this.processMsg(response, messages);
-    }
-
-    /**
-     * Create a chat loop that reads user input from the console and sends it to the server for processing.
-     */
-    async chatLoop() {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-            prompt: 'You: ',
-        });
-
-        console.log("MCP Client Started!\nType your queries or 'quit|q|exit' to exit.");
-        rl.prompt();
-
-        let lastPrintMessage = 0;
-        const messages: MessageParam[] = [];
-        rl.on('line', async (input) => {
-            const v = input.trim().toLowerCase();
-            if (v === 'quit' || v === 'q' || v === 'exit') {
-                rl.close();
-                return;
-            }
-            try {
-                await this.processQuery(input, messages);
-                for (let i = lastPrintMessage + 1; i < messages.length; i++) {
-                    if (messages[i].role === 'assistant') {
-                        console.log('CLAUDE:', messages[i].content);
-                    } else if (messages[i].role === 'user') {
-                        console.log('USER:', messages[i].content.slice(0, 500), '...');
-                    } else {
-                        console.log('CLAUDE[thinking]:', messages[i].content);
-                    }
-                }
-                lastPrintMessage += messages.length;
-            } catch (error) {
-                console.error('Error processing query:', error);
-            }
-            rl.prompt();
-        });
-    }
-}
-
-async function main() {
-    const client = new MCPClient();
-
-    if (process.argv.length < 3) {
-        if (DEBUG) {
-            process.argv.push(DEBUG_SERVER_PATH);
-        } else {
-            console.error('Usage: node <path_to_server_script>');
-            process.exit(1);
-        }
-    }
-
-    try {
-        await client.connectToServer(process.argv.slice(2));
-        await client.chatLoop();
-    } catch (error) {
-        console.error('Error:', error);
-    }
-}
-
-main().catch(console.error);

package/src/examples/client_sse.py

@@ -1,48 +0,0 @@
-"""
-Test Apify MCP Server using SSE client
-
-It is using python client as the typescript one does not support custom headers when connecting to the SSE server.
-
-Install python dependencies (assumes you have python installed):
-> pip install requests python-dotenv mcp
-"""
-
-import asyncio
-import os
-from pathlib import Path
-
-import requests
-from dotenv import load_dotenv
-from mcp.client.session import ClientSession
-from mcp.client.sse import sse_client
-
-load_dotenv(Path(__file__).resolve().parent.parent.parent / ".env")
-
-MCP_SERVER_URL = "https://actors-mcp-server.apify.actor"
-
-HEADERS = {"Authorization": f"Bearer {os.getenv('APIFY_TOKEN')}"}
-
-async def run() -> None:
-
-    print("Start MCP Server with Actors")
-    r = requests.get(MCP_SERVER_URL, headers=HEADERS)
-    print("MCP Server Response:", r.json(), end="\n\n")
-
-    async with sse_client(url=f"{MCP_SERVER_URL}/sse", timeout=60, headers=HEADERS) as (read, write):
-        async with ClientSession(read, write) as session:
-            await session.initialize()
-
-            tools = await session.list_tools()
-            print("Available Tools:", tools, end="\n\n")
-
-            if hasattr(tools, "tools") and not tools.tools:
-                print("No tools available!")
-                return
-
-            result = await session.call_tool("apify/rag-web-browser", { "query": "example.com", "maxResults": 3 })
-            print("Tools Call Result:")
-
-            for content in result.content:
-                print(content)
-
-asyncio.run(run())

package/src/index.ts

@@ -1,34 +0,0 @@
-/**
- * This script initializes and starts the Apify MCP server using the Stdio transport.
- *
- * Usage:
- *   node <script_name> --actors=<actor1,actor2,...>
- *
- * Command-line arguments:
- *   --actors - A comma-separated list of actor full names to add to the server.
- *
- * Example:
- *   node index.js --actors=apify/google-search-scraper,apify/instagram-scraper
- */
-
-import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import minimist from 'minimist';
-
-import { ApifyMcpServer } from './server.js';
-
-const argv = minimist(process.argv.slice(2));
-const argActors = argv.actors?.split(',').map((actor: string) => actor.trim()) || [];
-
-async function main() {
-    const server = new ApifyMcpServer();
-    await (argActors.length !== 0
-        ? server.addToolsFromActors(argActors)
-        : server.addToolsFromDefaultActors());
-    const transport = new StdioServerTransport();
-    await server.connect(transport);
-}
-
-main().catch((error) => {
-    console.error('Server error:', error); // eslint-disable-line no-console
-    process.exit(1);
-});

package/src/input.ts

@@ -1,16 +0,0 @@
-import type { Input } from './types.js';
-
-/**
- * Process input parameters, split actors string into an array
- * @param originalInput
- * @returns input
- */
-export async function processInput(originalInput: Partial<Input>): Promise<Input> {
-    const input = originalInput as Input;
-
-    // actors can be a string or an array of strings
-    if (input.actors && typeof input.actors === 'string') {
-        input.actors = input.actors.split(',').map((format: string) => format.trim()) as string[];
-    }
-    return input;
-}

package/src/logger.ts

@@ -1,5 +0,0 @@
-import { log } from 'apify';
-
-log.setLevel(log.LEVELS.DEBUG);
-
-export { log };