项目简介

MCP-Use-TS 是一个用于 TypeScript 的 MCP 库。它允许你轻松配置和连接到多个 MCP 服务器，并在你的项目中使用它们。这个库旨在简化与不同 MCP 实现（如 Playwright MCP）的集成，使你可以专注于实现业务逻辑。

如果你有任何问题或建议，请随时提出 issue 或 pull request。

安装

npm install mcp-use-typscript

快速入门

项目配置

在你的 TypeScript 项目中创建一个 mcp-config.ts 文件：

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;

启动 MCP 服务器

在你的项目根目录下创建一个 start-mcp.ts 文件：

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

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

main().catch(console.error);

运行命令启动 MCP 服务器：

npm run start-mcp

使用示例

在你的 TypeScript 文件中导入并使用 MCP 客户端和代理：

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('你的任务指令');
  console.log(result);
}

main().catch(console.error);

功能特性

• 支持同时连接到多个 MCP 服务器。
• 提供灵活的配置选项，允许自定义每个服务器的启动参数。
• 内置代理功能，方便在项目中管理和使用不同 MCP 服务。

使用说明

配置文件格式

你的配置文件应包含以下内容：

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

创建代理

你可以通过 createMCPAgent 函数创建一个代理实例。这个代理将连接到所有配置中的服务器，并根据需要选择合适的工具来执行任务。

示例代码

配置多个服务器

在你的项目中，可以在配置文件中定义多个 MCP 服务器：

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

创建代理

在你的 TypeScript 文件中，可以使用以下代码创建代理：

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('你的任务指令');
  console.log(result);
}

main().catch(console.error);

贡献指南

如果你希望为这个项目贡献代码或文档，请参考我们的 CONTRIBUTING.md 文件，了解如何参与和提交代码。

English | 简体中文