使用说明(Markdown格式)
-
项目简介
- 这是一个基于 MCP 的服务器实现,聚合 Keywords Everywhere 的 API,向 LLM 客户端暴露多种“工具”(如获取关键词数据、相关关键词、域名分析、流量、反向链接等)以及资源数据的访问能力,支持通过 JSON-RPC 与客户端进行交互。
-
主要功能点
- 提供关键词数据、相关关键词、PASF、域名关键词、URL 关键词、流量指标、反向链接等工具,输出易于展示的文本结果。
- 支持多种传输方式:默认通过 Streamable HTTP transport,另含 STDIO 传输选项,便于不同部署场景。
- MCP 会话管理:通过初始化请求建立会话,后续请求携带会话标识(Mcp-Session-Id)以维持会话状态。
- 服务器信息与分析:/health、/analytics、/analytics/dashboard 等接口提供健康、使用统计与可视化数据。
- 错误处理与限流:对常见错误给出友好提示,支持限流时的重试。
- 自托管部署与托管端点:可自行搭建服务器或使用公开托管端点。
- 安全性:支持通过 URL 参数或请求头传入的 API Key,默认 API Key 可通过环境变量 KEYWORDS_EVERYWHERE_API_KEY 提供。
-
安装步骤
- 确保 Node.js 版本为 18 及以上。
- 获取 Keywords Everywhere API Key(用于调用外部 API)。
- 将 API Key 设置为环境变量 KEYWORDS_EVERYWHERE_API_KEY,或在请求中通过 query 参数 apiKey 提供(如需临时覆盖默认密钥)。
- 安装依赖并运行服务(本仓库提供了 npm / npx 启动方式,详见 README)。
- 部署选项包括本地运行、Docker、以及将服务暴露到互联网的托管环境。
-
服务器配置(MCP 客户端所需) 说明:MCP 客户端需要在启动时提供一个配置,描述服务器的启动命令与参数等信息。本段给出符合仓库实现的配置示例(以 JSON 形式呈现,便于理解,实际使用时请按客户端文档或工具所需格式提供)。该配置用于 MCP 客户端连接并启动对应的 MCP 服务器。
{ "server_name": "keywords-everywhere", "command": "npx", "args": ["-y", "mcp-keywords-everywhere"], "env": { "KEYWORDS_EVERYWHERE_API_KEY": "YOUR_API_KEY" }, "comment": "MCP 服务器名称、启动命令及参数(命令示例与仓库实现一致,env 可覆盖默认 API Key)。客户端不需要开发者配置细节,仅通过此信息了解如何启动服务。" }
-
基本使用方法
- 启动服务器后,客户端应先执行 initialize 请求以建立会话。
- 初始化成功后,可通过 invoke 或工具调用(tools/call / invoke)来执行预定义的工具,例如获取账户余额、关键词数据、域名关键词等。
- 使用 analytics 接口查看服务器运行态势与简单统计信息。
- 为使用示例中的 hosted 服务,直接通过托管端点进行调用,或在本地部署后通过本地地址访问。
信息
分类
网页与API