Easy MCP Use

🚀 MCP-Use-TS

MCP-Use-TS is a TypeScript library for MCP. It enables you to easily configure and connect to multiple MCP servers and use them in your projects. This library simplifies integration with different MCP implementations (such as Playwright MCP), allowing you to focus on implementing business logic.

🚀 Quick Start

MCP-Use-TS is a TypeScript library designed to simplify the process of configuring and connecting to multiple MCP servers. This guide will walk you through the steps to get started with the library.

Project Configuration

Create a mcp-config.ts file in your TypeScript project:

import type { MCPConfig } from 'mcp-use-typscript';

const config: MCPConfig = {
  servers: [
    {
      name: 'playwright',
      command: 'npx',
      args: ['@playwright/mcp', '--version'],
      options: {
        cwd: '.',
        stdio: 'inherit'
      }
    },
    {
      name: 'airbnb',
      command: 'npx',
      args: ['-y', '@openfb/mcp-server-airbnb']
    }
  ]
};

export default config;

Start the MCP Server

Create a start-mcp.ts file in the root directory of your project:

import { startMCP } from 'mcp-use-typscript';

async function main() {
  await startMCP();
}

main().catch(console.error);

Run the following command to start the MCP server:

npm run start-mcp

Usage Example

Import and use the MCP client and proxy in your TypeScript file:

import { createMCPClient, createMCPAgent } from 'mcp-use-typscript';

async function main() {
  const client = await createMCPClient();
  const agent = createMCPAgent({
    client,
    llm: new LLM(),
    verbose: true
  });

  const result = await agent.run('Your task instruction');
  console.log(result);
}

main().catch(console.error);

✨ Features

• Support for connecting to multiple MCP servers simultaneously.
• Flexible configuration options, allowing customization of startup parameters for each server.
• Built - in proxy functionality for easy management and use of different MCP services in projects.

📦 Installation

npm install mcp-use-typscript

💻 Usage Examples

Basic Usage

import { createMCPClient, createMCPAgent } from 'mcp-use-typscript';

async function main() {
  const client = await createMCPClient();
  const agent = createMCPAgent({
    client,
    llm: new LLM(),
    verbose: true
  });

  const result = await agent.run('Your task instruction');
  console.log(result);
}

main().catch(console.error);

Advanced Usage

// Advanced scenarios can include more complex configurations and operations, such as customizing the behavior of the LLM and handling errors.
import { createMCPClient, createMCPAgent } from 'mcp-use-typscript';

async function main() {
  const client = await createMCPClient();
  const agent = createMCPAgent({
    client,
    llm: new LLM({ customOption: 'value' }),
    verbose: false
  });

  try {
    const result = await agent.run('Your complex task instruction');
    console.log(result);
  } catch (error) {
    console.error('An error occurred:', error);
  }
}

main().catch(console.error);

📚 Documentation

Configuration File Format

Your configuration file should contain the following content:

interface MCPConfig {
  servers: Array<{
    name: string;
    command: string;
    args?: string[];
    options?: Record<string, unknown>;
  }>;
}

Creating a Proxy

You can create a proxy instance using the createMCPAgent function. This proxy will connect to all configured servers and select the appropriate tool to execute tasks as needed.

Example Code

Configuring Multiple Servers

In your project, you can define multiple MCP servers in the configuration file:

{
  "mcpConfig": {
    "servers": [
      {
        "name": "playwright",
        "command": "npx",
        "args": ["@playwright/mcp", "--version"],
        "options": {
          "cwd": ".",
          "stdio": "inherit"
        }
      },
      {
        "name": "airbnb",
        "command": "npx",
        "args": ["-y", "@openfb/mcp-server-airbnb"]
      }
    ]
  }
}

Creating a Proxy

In your TypeScript file, you can use the following code to create a proxy:

import { createMCPClient, createMCPAgent } from 'mcp-use-typscript';

async function main() {
  const client = await createMCPClient();
  const agent = createMCPAgent({
    client,
    llm: new LLM(),
    verbose: true
  });

  const result = await agent.run('Your task instruction');
  console.log(result);
}

main().catch(console.error);

🤝 Contribution Guide

If you wish to contribute code or documentation to this project, please refer to our CONTRIBUTING.md file for instructions on how to participate and submit your code.

If you have any questions or suggestions, please feel free to open an issue or submit a pull request.