项目简介

该仓库包含 DataForSEO 模型上下文协议 (MCP) 服务器的 TypeScript 实现。它旨在通过标准化的 MCP 接口,使大型语言模型 (LLM) 客户端能够访问 DataForSEO 的各种 API,从而获取实时的 SEO 数据,如搜索结果、关键词研究信息、网页分析数据等。

主要功能点

  • 搜索引擎结果 (SERP) API: 获取 Google, Bing, Yahoo 的实时搜索结果页面数据。
  • 关键词数据 (KEYWORDS_DATA) API: 提供关键词研究和点击流数据,包括搜索量、每次点击成本 (CPC) 等指标。
  • 网页分析 (ONPAGE) API: 允许抓取网站和网页,获取定制的网页 SEO 性能指标。
  • DataForSEO Labs API: 基于 DataForSEO 内部数据库和算法,提供关键词、SERP 和域名的高级分析数据。
  • 支持通过 MCP 协议注册和调用这些 API 提供的具体功能(作为工具)。
  • 通过 Stdio 传输协议与 MCP 客户端通信。

安装步骤

  1. 克隆仓库到本地:
    git clone https://github.com/dataforseo/mcp-server-typescript
    cd mcp-server-typescript
  2. 安装项目依赖:
    npm install
  3. 设置 DataForSEO API 凭据为环境变量:
    • 打开终端或使用 '.env' 文件设置:
      export DATAFORSEO_USERNAME=你的DataForSEO用户名
      export DATAFORSEO_PASSWORD=你的DataForSEO密码
    • (可选)设置 'ENABLED_MODULES' 环境变量来指定启用的模块(如 '"SERP,KEYWORDS_DATA"'),默认为启用所有模块。
      export ENABLED_MODULES="SERP,KEYWORDS_DATA,ONPAGE,DATAFORSEO_LABS"
  4. 构建项目:
    npm run build

服务器配置(供 MCP 客户端连接)

要使 MCP 客户端(如 LLM 客户端)连接到此服务器,客户端需要知道如何启动服务器并与其建立通信。对于使用 Stdio 传输的 MCP 服务器,客户端通常需要以下信息:

  • server name: 服务器在 MCP 协议中声明的名称,此服务器为 'dataforseo'。
  • command: 启动服务器的可执行程序路径。对于此 Node.js 服务器,通常是 'node'。
  • args: 传递给启动程序的参数,即服务器主脚本的路径,此服务器构建后为 'build/index.js'。

客户端在连接时,会使用指定的 'command' 和 'args' 启动服务器进程,并通过标准输入/输出 (Stdio) 与服务器进行 JSON-RPC 通信。请确保运行服务器的环境已设置好必需的 'DATAFORSEO_USERNAME' 和 'DATAFORSEO_PASSWORD' 环境变量。

基本使用方法

  1. 按照上述步骤完成安装和构建,并设置好环境变量。
  2. 运行服务器:
    node build/index.js
    服务器将在 Stdio 上启动并监听 MCP 客户端连接。
  3. 配置您的 MCP 客户端(通常是 LLM 应用程序或 SDK)使用上述的配置信息('server name', 'command', 'args')连接到该服务器。
  4. 连接成功后,MCP 客户端可以通过协议发现服务器提供的工具(例如 'serp-organic-live-advanced', 'datalabs_google_ranked_keywords' 等),并按工具定义的参数调用它们来获取 DataForSEO API 的数据。具体工具的名称、描述和参数定义可以通过 MCP 协议由客户端查询获得。

信息

分类

网页与API