Easy MCP Use

🚀 MCP-Use-TS

MCP-Use-TS 是一個專為 TypeScript 打造的 MCP 庫。它能讓你輕鬆配置並連接多個 MCP 服務器，還能在項目中便捷使用這些服務器。該庫旨在簡化與不同 MCP 實現（如 Playwright MCP）的集成，讓你能更專注於業務邏輯的實現。

如果你有任何問題或建議，歡迎隨時提出 issue 或 pull request。

🚀 快速開始

項目配置

在你的 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 服務。

📦 安裝指南

npm install mcp-use-typscript

📚 詳細文檔

配置文件格式

你的配置文件應包含以下內容：

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 文件，瞭解如何參與和提交代碼。