mcp-use 0.1.19 → 0.2.0

package/dist/examples/filesystem_use.js

@@ -1,43 +0,0 @@
-/**
- * Basic usage example for mcp-use.
- *
- * This example demonstrates how to use the mcp-use library with MCPClient
- * to connect any LLM to MCP tools through a unified interface.
- *
- * Special Thanks to https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem
- * for the server.
- */
-import { ChatOpenAI } from '@langchain/openai';
-import { config } from 'dotenv';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-const serverConfig = {
-    mcpServers: {
-        filesystem: {
-            command: 'npx',
-            args: [
-                '-y',
-                '@modelcontextprotocol/server-filesystem',
-                'THE_PATH_TO_YOUR_DIRECTORY',
-            ],
-        },
-    },
-};
-async function main() {
-    // Create MCPClient from config
-    const client = MCPClient.fromDict(serverConfig);
-    // Create LLM
-    const llm = new ChatOpenAI({ model: 'gpt-4o' });
-    // const llm = init_chat_model({ model: "llama-3.1-8b-instant", model_provider: "groq" })
-    // const llm = new ChatAnthropic({ model: "claude-3-" })
-    // const llm = new ChatGroq({ model: "llama3-8b-8192" })
-    // Create agent with the client
-    const agent = new MCPAgent({ llm, client, maxSteps: 30 });
-    // Run the query
-    const result = await agent.run('Hello can you give me a list of files and directories in the current directory', 30);
-    console.log(`\nResult: ${result}`);
-}
-if (import.meta.url === `file://${process.argv[1]}`) {
-    main().catch(console.error);
-}

package/dist/examples/http_example.d.ts

@@ -1,18 +0,0 @@
-/**
- * HTTP Example for mcp-use.
- *
- * This example demonstrates how to use the mcp-use library with MCPClient
- * to connect to an MCP server running on a specific HTTP port.
- *
- * Before running this example, you need to start the Playwright MCP server
- * in another terminal with:
- *
- *     npx @playwright/mcp@latest --port 8931
- *
- * This will start the server on port 8931. Resulting in the config you find below.
- * Of course you can run this with any server you want at any URL.
- *
- * Special thanks to https://github.com/microsoft/playwright-mcp for the server.
- */
-export {};
-//# sourceMappingURL=http_example.d.ts.map

package/dist/examples/http_example.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"http_example.d.ts","sourceRoot":"","sources":["../../examples/http_example.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}

package/dist/examples/http_example.js

@@ -1,37 +0,0 @@
-/**
- * HTTP Example for mcp-use.
- *
- * This example demonstrates how to use the mcp-use library with MCPClient
- * to connect to an MCP server running on a specific HTTP port.
- *
- * Before running this example, you need to start the Playwright MCP server
- * in another terminal with:
- *
- *     npx @playwright/mcp@latest --port 8931
- *
- * This will start the server on port 8931. Resulting in the config you find below.
- * Of course you can run this with any server you want at any URL.
- *
- * Special thanks to https://github.com/microsoft/playwright-mcp for the server.
- */
-import { ChatOpenAI } from '@langchain/openai';
-import { config } from 'dotenv';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-async function main() {
-    const config = { mcpServers: { http: { url: 'https://gitmcp.io/docs' } } };
-    // Create MCPClient from config
-    const client = MCPClient.fromDict(config);
-    // Create LLM
-    const llm = new ChatOpenAI({ model: 'gpt-4o' });
-    // Create agent with the client
-    const agent = new MCPAgent({ llm, client, maxSteps: 30 });
-    // Run the query
-    const result = await agent.run('Which tools are available and what can they do?', 30);
-    console.log(`\nResult: ${result}`);
-    await agent.close();
-}
-if (import.meta.url === `file://${process.argv[1]}`) {
-    main().catch(console.error);
-}

package/dist/examples/mcp_everything.d.ts

@@ -1,6 +0,0 @@
-/**
- * This example shows how to test the different functionalities of MCPs using the MCP server from
- * anthropic.
- */
-export {};
-//# sourceMappingURL=mcp_everything.d.ts.map

package/dist/examples/mcp_everything.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mcp_everything.d.ts","sourceRoot":"","sources":["../../examples/mcp_everything.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/examples/mcp_everything.js

@@ -1,25 +0,0 @@
-/**
- * This example shows how to test the different functionalities of MCPs using the MCP server from
- * anthropic.
- */
-import { ChatOpenAI } from '@langchain/openai';
-import { config } from 'dotenv';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-const everythingServer = {
-    mcpServers: { everything: { command: 'npx', args: ['-y', '@modelcontextprotocol/server-everything'] } },
-};
-async function main() {
-    const client = new MCPClient(everythingServer);
-    const llm = new ChatOpenAI({ model: 'gpt-4o', temperature: 0 });
-    const agent = new MCPAgent({ llm, client, maxSteps: 30 });
-    const result = await agent.run(`Hello, you are a tester can you please answer the follwing questions:
-- Which resources do you have access to?
-- Which prompts do you have access to?
-- Which tools do you have access to?`, 30);
-    console.log(`\nResult: ${result}`);
-}
-if (import.meta.url === `file://${process.argv[1]}`) {
-    main().catch(console.error);
-}

package/dist/examples/multi_server_example.d.ts

@@ -1,10 +0,0 @@
-/**
- * Example demonstrating how to use MCPClient with multiple servers.
- *
- * This example shows how to:
- * 1. Configure multiple MCP servers
- * 2. Create and manage sessions for each server
- * 3. Use tools from different servers in a single agent
- */
-export {};
-//# sourceMappingURL=multi_server_example.d.ts.map

package/dist/examples/multi_server_example.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multi_server_example.d.ts","sourceRoot":"","sources":["../../examples/multi_server_example.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/dist/examples/multi_server_example.js

@@ -1,51 +0,0 @@
-/**
- * Example demonstrating how to use MCPClient with multiple servers.
- *
- * This example shows how to:
- * 1. Configure multiple MCP servers
- * 2. Create and manage sessions for each server
- * 3. Use tools from different servers in a single agent
- */
-import { ChatAnthropic } from '@langchain/anthropic';
-import { config } from 'dotenv';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-async function runMultiServerExample() {
-    // Create a configuration with multiple servers
-    const config = {
-        mcpServers: {
-            airbnb: {
-                command: 'npx',
-                args: ['-y', '@openbnb/mcp-server-airbnb', '--ignore-robots-txt'],
-            },
-            playwright: {
-                command: 'npx',
-                args: ['@playwright/mcp@latest'],
-                env: { DISPLAY: ':1' },
-            },
-            filesystem: {
-                command: 'npx',
-                args: [
-                    '-y',
-                    '@modelcontextprotocol/server-filesystem',
-                    'YOUR_DIRECTORY_HERE',
-                ],
-            },
-        },
-    };
-    // Create MCPClient with the multi-server configuration
-    const client = MCPClient.fromDict(config);
-    // Create LLM
-    const llm = new ChatAnthropic({ model: 'claude-3-5-sonnet-20240620' });
-    // Create agent with the client
-    const agent = new MCPAgent({ llm, client, maxSteps: 30 });
-    // Example 1: Using tools from different servers in a single query
-    const result = await agent.run('Search for a nice place to stay in Barcelona on Airbnb, '
-        + 'then use Google to find nearby restaurants and attractions.'
-        + 'Write the result in the current directory in restarant.txt', 30);
-    console.log(result);
-}
-if (import.meta.url === `file://${process.argv[1]}`) {
-    runMultiServerExample().catch(console.error);
-}

package/dist/examples/observability.d.ts

@@ -1,6 +0,0 @@
-/**
- * This example shows how to test the different functionalities of MCPs using the MCP server from
- * anthropic.
- */
-export {};
-//# sourceMappingURL=observability.d.ts.map

package/dist/examples/observability.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../examples/observability.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/examples/observability.js

@@ -1,50 +0,0 @@
-/**
- * This example shows how to test the different functionalities of MCPs using the MCP server from
- * anthropic.
- */
-import { ChatOpenAI } from '@langchain/openai';
-import { config } from 'dotenv';
-import { Logger, MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-// Enable debug logging to see observability messages
-Logger.setDebug(true);
-const everythingServer = {
-    mcpServers: { everything: { command: 'npx', args: ['-y', '@modelcontextprotocol/server-everything'] } },
-};
-async function main() {
-    console.log('🚀 Starting MCP Observability example with Langfuse tracing...');
-    console.log('📊 Environment variables:');
-    console.log(`   LANGFUSE_PUBLIC_KEY: ${process.env.LANGFUSE_PUBLIC_KEY ? '✅ Set' : '❌ Missing'}`);
-    console.log(`   LANGFUSE_SECRET_KEY: ${process.env.LANGFUSE_SECRET_KEY ? '✅ Set' : '❌ Missing'}`);
-    console.log(`   LANGFUSE_HOST: ${process.env.LANGFUSE_HOST || 'Not set'}`);
-    console.log(`   MCP_USE_LANGFUSE: ${process.env.MCP_USE_LANGFUSE || 'Not set'}`);
-    const client = new MCPClient(everythingServer);
-    const llm = new ChatOpenAI({ model: 'gpt-4o', temperature: 0 });
-    const agent = new MCPAgent({
-        llm,
-        client,
-        maxSteps: 30,
-    });
-    // console.log('🔧 Initializing agent...')
-    // await agent.initialize()
-    // Set additional metadata for testing (Optional)
-    agent.setMetadata({
-        agent_id: 'test-agent-123',
-        test_run: true,
-        example: 'mcp_observability',
-    });
-    agent.setTags(['test-tag-1', 'test-tag-2']);
-    console.log('💬 Running agent query...');
-    const result = await agent.run(`Hello, you are a tester can you please answer the follwing questions:
-- Which resources do you have access to?
-- Which prompts do you have access to?
-- Which tools do you have access to?`, 30);
-    console.log(`\n✅ Result: ${result}`);
-    // console.log('🧹 Closing agent...')
-    // await agent.close()
-    // console.log('🎉 Example completed! Check your Langfuse dashboard for traces.')
-}
-if (import.meta.url === `file://${process.argv[1]}`) {
-    main().catch(console.error);
-}

package/dist/examples/stream_example.d.ts

@@ -1,12 +0,0 @@
-/**
- * This example demonstrates how to use the stream method of MCPAgent to get
- * intermediate steps and observe the agent's reasoning process in real-time.
- *
- * The stream method returns an AsyncGenerator that yields AgentStep objects
- * for each intermediate step, and finally returns the complete result.
- *
- * This example also demonstrates the streamEvents method which yields
- * LangChain StreamEvent objects for more granular, token-level streaming.
- */
-export {};
-//# sourceMappingURL=stream_example.d.ts.map

package/dist/examples/stream_example.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stream_example.d.ts","sourceRoot":"","sources":["../../examples/stream_example.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/dist/examples/stream_example.js

@@ -1,198 +0,0 @@
-/**
- * This example demonstrates how to use the stream method of MCPAgent to get
- * intermediate steps and observe the agent's reasoning process in real-time.
- *
- * The stream method returns an AsyncGenerator that yields AgentStep objects
- * for each intermediate step, and finally returns the complete result.
- *
- * This example also demonstrates the streamEvents method which yields
- * LangChain StreamEvent objects for more granular, token-level streaming.
- */
-import { ChatAnthropic } from '@langchain/anthropic';
-import { config } from 'dotenv';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-const everythingServer = {
-    mcpServers: { everything: { command: 'npx', args: ['-y', '@modelcontextprotocol/server-everything'] } },
-};
-async function streamingExample() {
-    console.log('🚀 Starting streaming example...\n');
-    // Initialize MCP client and agent
-    const client = new MCPClient(everythingServer);
-    const llm = new ChatAnthropic({ model: 'claude-sonnet-4-20250514', temperature: 0 });
-    const agent = new MCPAgent({
-        llm,
-        client,
-        maxSteps: 10,
-        verbose: true,
-    });
-    const query = `Please help me understand what capabilities you have:
-1. List all available tools
-2. Try using a few different tools to demonstrate their functionality
-3. Show me what resources and prompts are available
-4. Create a simple example to showcase your abilities`;
-    console.log(`📝 Query: ${query}\n`);
-    console.log('🔄 Starting to stream agent steps...\n');
-    try {
-        // Use the stream method to get intermediate steps
-        const stream = agent.stream(query);
-        let stepNumber = 1;
-        // Iterate through the async generator to get intermediate steps
-        for await (const step of stream) {
-            console.log(`\n--- Step ${stepNumber} ---`);
-            console.log(`🔧 Tool: ${step.action.tool}`);
-            console.log(`📥 Input: ${JSON.stringify(step.action.toolInput, null, 2)}`);
-            console.log(`📤 Output: ${step.observation}`);
-            console.log('---\n');
-            stepNumber++;
-        }
-        // The final result is the return value when the generator is done
-        // Note: In the loop above, we don't get the final result directly
-        // To get it, we need to manually handle the generator
-    }
-    catch (error) {
-        console.error('❌ Error during streaming:', error);
-    }
-    console.log('\n🎉 Streaming complete!');
-}
-async function streamingExampleWithFinalResult() {
-    console.log('\n\n🚀 Starting streaming example with final result capture...\n');
-    // Initialize MCP client and agent
-    const client = new MCPClient(everythingServer);
-    const llm = new ChatAnthropic({ model: 'claude-sonnet-4-20250514', temperature: 0 });
-    const agent = new MCPAgent({
-        llm,
-        client,
-        maxSteps: 8,
-        verbose: false, // Less verbose for cleaner output
-    });
-    const query = `What tools do you have access to? Please test 2-3 of them to show me what they can do.`;
-    console.log(`📝 Query: ${query}\n`);
-    console.log('🔄 Processing with intermediate steps...\n');
-    try {
-        // Create the stream generator
-        const stream = agent.stream(query);
-        let stepNumber = 1;
-        let result = '';
-        // Manually iterate through the generator to capture both steps and final result
-        while (true) {
-            const { done, value } = await stream.next();
-            if (done) {
-                // Generator is complete, value contains the final result
-                result = value;
-                break;
-            }
-            else {
-                // value is an AgentStep
-                console.log(`\n🔧 Step ${stepNumber}: ${value.action.tool}`);
-                console.log(`   Input: ${JSON.stringify(value.action.toolInput)}`);
-                console.log(`   Result: ${value.observation.slice(0, 100)}${value.observation.length > 100 ? '...' : ''}`);
-                stepNumber++;
-            }
-        }
-        console.log(`\n${'='.repeat(50)}`);
-        console.log('🎯 FINAL RESULT:');
-        console.log('='.repeat(50));
-        console.log(result);
-    }
-    catch (error) {
-        console.error('❌ Error during streaming:', error);
-    }
-    finally {
-        // Clean up
-        await client.closeAllSessions();
-    }
-    console.log('\n✅ Example complete!');
-}
-async function streamEventsExample() {
-    console.log('\n\n🚀 Starting streamEvents example (token-level streaming)...\n');
-    // Initialize MCP client and agent
-    const client = new MCPClient(everythingServer);
-    const llm = new ChatAnthropic({ model: 'claude-sonnet-4-20250514', temperature: 0 });
-    const agent = new MCPAgent({
-        llm,
-        client,
-        maxSteps: 5,
-        verbose: false,
-    });
-    const query = `What's the current time and date? Also create a simple text file with today's date.`;
-    console.log(`📝 Query: ${query}\n`);
-    console.log('🔄 Streaming fine-grained events...\n');
-    try {
-        // Use streamEvents for token-level streaming
-        const eventStream = agent.streamEvents(query);
-        let eventCount = 0;
-        let currentToolCall = null;
-        for await (const event of eventStream) {
-            eventCount++;
-            // Log different types of events
-            switch (event.event) {
-                case 'on_chain_start':
-                    if (event.name === 'AgentExecutor') {
-                        console.log('🏁 Agent execution started');
-                    }
-                    break;
-                case 'on_tool_start':
-                    currentToolCall = event.name;
-                    console.log(`\n🔧 Tool started: ${event.name}`);
-                    if (event.data?.input) {
-                        console.log(`   Input: ${JSON.stringify(event.data.input)}`);
-                    }
-                    break;
-                case 'on_tool_end':
-                    if (event.name === currentToolCall) {
-                        console.log(`✅ Tool completed: ${event.name}`);
-                        if (event.data?.output) {
-                            const output = typeof event.data.output === 'string'
-                                ? event.data.output
-                                : JSON.stringify(event.data.output);
-                            console.log(`   Output: ${output.slice(0, 100)}${output.length > 100 ? '...' : ''}`);
-                        }
-                        currentToolCall = null;
-                    }
-                    break;
-                case 'on_chat_model_stream':
-                    // This shows token-by-token streaming from the LLM
-                    if (event.data?.chunk?.text) {
-                        const textContent = event.data.chunk.text;
-                        if (typeof textContent === 'string' && textContent.length > 0) {
-                            process.stdout.write(textContent);
-                        }
-                    }
-                    break;
-                case 'on_chain_end':
-                    if (event.name === 'AgentExecutor') {
-                        console.log('\n\n🏁 Agent execution completed');
-                    }
-                    break;
-                // You can handle many more event types:
-                // - on_llm_start, on_llm_end
-                // - on_parser_start, on_parser_end
-                // - on_retriever_start, on_retriever_end
-                // - etc.
-            }
-            // Limit output for demo purposes
-            if (eventCount > 200) {
-                console.log('\n... (truncated for demo)');
-                break;
-            }
-        }
-        console.log(`\n\n📊 Total events emitted: ${eventCount}`);
-    }
-    catch (error) {
-        console.error('❌ Error during event streaming:', error);
-    }
-    finally {
-        await client.closeAllSessions();
-    }
-    console.log('\n✅ StreamEvents example complete!');
-}
-// Run all examples
-async function runAllExamples() {
-    await streamingExample();
-    await streamingExampleWithFinalResult();
-    await streamEventsExample();
-}
-// Run the examples
-runAllExamples().catch(console.error);

package/dist/examples/structured_output.d.ts

@@ -1,9 +0,0 @@
-/**
- * Structured Output Example - City Research with Playwright
- *
- * This example demonstrates intelligent structured output by researching Padova, Italy.
- * The agent becomes schema-aware and will intelligently retry to gather missing
- * information until all required fields can be populated.
- */
-export {};
-//# sourceMappingURL=structured_output.d.ts.map

package/dist/examples/structured_output.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"structured_output.d.ts","sourceRoot":"","sources":["../../examples/structured_output.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/examples/structured_output.js

@@ -1,95 +0,0 @@
-/**
- * Structured Output Example - City Research with Playwright
- *
- * This example demonstrates intelligent structured output by researching Padova, Italy.
- * The agent becomes schema-aware and will intelligently retry to gather missing
- * information until all required fields can be populated.
- */
-import { ChatOpenAI } from '@langchain/openai';
-import { config } from 'dotenv';
-import { z } from 'zod';
-import { MCPAgent, MCPClient } from '../index.js';
-// Load environment variables from .env file
-config();
-// Define the structured output schema using Zod
-const CityInfoSchema = z.object({
-    name: z.string().describe('Official name of the city'),
-    country: z.string().describe('Country where the city is located'),
-    region: z.string().describe('Region or state within the country'),
-    population: z.number().describe('Current population count'),
-    area_km2: z.number().describe('Area in square kilometers'),
-    foundation_date: z.string().describe('When the city was founded (approximate year or period)'),
-    mayor: z.string().describe('Current mayor or city leader'),
-    famous_landmarks: z.array(z.string()).describe('List of famous landmarks, monuments, or attractions'),
-    universities: z.array(z.string()).describe('List of major universities or educational institutions'),
-    economy_sectors: z.array(z.string()).describe('Main economic sectors or industries'),
-    sister_cities: z.array(z.string()).describe('Twin cities or sister cities partnerships'),
-    historical_significance: z.string().describe('Brief description of historical importance'),
-    climate_type: z.string().nullable().describe('Type of climate (e.g., Mediterranean, Continental)'),
-    elevation_meters: z.number().nullable().describe('Elevation above sea level in meters'),
-});
-async function main() {
-    const mcpConfig = {
-        mcpServers: {
-            playwright: {
-                command: 'npx',
-                args: ['@playwright/mcp@latest'],
-                env: {
-                    DISPLAY: ':1',
-                },
-            },
-        },
-    };
-    const client = new MCPClient(mcpConfig);
-    const llm = new ChatOpenAI({ model: 'gpt-4o' });
-    const agent = new MCPAgent({ llm, client, maxSteps: 50, memoryEnabled: true });
-    try {
-        // Use structured output with intelligent retry
-        // The agent will:
-        // 1. Know exactly what information it needs to collect
-        // 2. Attempt structured output at finish points
-        // 3. Continue execution if required information is missing
-        // 4. Only finish when all required fields can be populated
-        const result = await agent.run(`
-      Research comprehensive information about the city of Padova (also known as Padua) in Italy.
-      
-      Visit multiple reliable sources like Wikipedia, official city websites, tourism sites,
-      and university websites to gather detailed information including demographics, history,
-      governance, education, economy, landmarks, and international relationships.
-      `, 50, // maxSteps
-        true, // manageConnector
-        [], // externalHistory
-        CityInfoSchema);
-        // Now you have strongly-typed, validated data!
-        console.log(`Name: ${result.name}`);
-        console.log(`Country: ${result.country}`);
-        console.log(`Region: ${result.region}`);
-        console.log(`Population: ${result.population.toLocaleString()}`);
-        console.log(`Area: ${result.area_km2} km²`);
-        console.log(`Foundation: ${result.foundation_date}`);
-        console.log(`Mayor: ${result.mayor}`);
-        console.log(`Universities: ${result.universities.join(', ')}`);
-        console.log(`Economy: ${result.economy_sectors.join(', ')}`);
-        console.log(`Landmarks: ${result.famous_landmarks.join(', ')}`);
-        console.log(`Sister Cities: ${result.sister_cities.length > 0 ? result.sister_cities.join(', ') : 'None'}`);
-        console.log(`Historical Significance: ${result.historical_significance}`);
-        if (result.climate_type) {
-            console.log(`Climate: ${result.climate_type}`);
-        }
-        if (result.elevation_meters !== null) {
-            console.log(`Elevation: ${result.elevation_meters} meters`);
-        }
-    }
-    catch (error) {
-        console.error('Error:', error);
-    }
-    finally {
-        await agent.close();
-    }
-}
-// Handle unhandled promise rejections
-process.on('unhandledRejection', (reason, promise) => {
-    console.error('Unhandled Rejection at:', promise, 'reason:', reason);
-    process.exit(1);
-});
-main().catch(console.error);