article
README
🚀 Haloscan MCP Server
Haloscan MCP Server 是一个用于与 Haloscan SEO API 进行交互的模型上下文协议(MCP)服务器。该服务器支持轻松集成 Claude for Desktop、N8N 等 MCP 兼容客户端。
🚀 快速开始
若要使用 Haloscan MCP Server,你需要完成以下配置步骤:
- 注册 Haloscan 账户。
- 选择合适的套餐。
- 在 配置 API 页面 生成你的 API 密钥。
- 在 Claude Desktop 配置文件中使用该 API 密钥来连接 Haloscan 服务器。
✨ 主要特性
- 通过 MCP 工具公开 Haloscan SEO API 的功能。
- 为常见的 SEO 任务提供提示。
- 可轻松与 N8N 等工作流自动化工具集成。
📦 安装指南
你可以将此服务器添加到 Claude Desktop 配置文件 claude_desktop_config.json 中,以下是使用 NPX 的配置示例:
{
"mcpServers": {
"haloscan": {
"command": "npx",
"args": [
"-y",
"@occirank/haloscan-server",
"start"
],
"env": {
"HALOSCAN_API_KEY": "YOUR API KEY"
}
}
}
}
💻 使用示例
基础用法
在 claude_desktop_config.json 中配置 Haloscan MCP Server 的示例:
{
"mcpServers": {
"haloscan": {
"command": "npx",
"args": [
"-y",
"@occirank/haloscan-server",
"start"
],
"env": {
"HALOSCAN_API_KEY": "YOUR API KEY"
}
}
}
}
📚 详细文档
工具介绍
1. 用户工具
- get_user_credit
- 功能:检索由提供的 API 密钥标识的用户的剩余信用额度。
2. 关键词探索工具
- get_keywords_overview
- 功能:检索特定关键词的概述,提供关键性能指标,如搜索量、竞争水平和随时间的趋势。
- 输入参数:
keyword(字符串):请求的关键词。requested_data(字符串数组):可以是 [keyword_match, related_search, related_question, similar_category, similar_serp, top_sites, similar_highlight, categories, synonyms, metrics, volume_history, serp ] 的任意组合。
- get_keywords_match
- 功能:基于精确匹配搜索检索关键词数据,提供有关特定关键词在搜索引擎中表现的详细见解。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_similar
- 功能:检索与给定关键词在语义或主题上相似的关键词列表。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_highlights
- 功能:从给定关键词中检索关键性能亮点。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_related
- 功能:检索与给定关键词在上下文或主题上相关的关键词列表。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_questions
- 功能:检索与给定关键词相关的基于问题的关键词列表。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_synonyms
- 功能:检索与给定关键词相关的同义词列表。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_find
- 功能:检索给定关键词或关键词列表的综合数据,包括搜索量、竞争情况和趋势分析。
- 输入参数:
keyword(字符串):请求的关键词。keywords(字符串数组):请求的关键词列表。keywords_sources(字符串数组):用于从输入中查找关键词的策略(可以是 [match, serp, related, highlights, categories, questions] 的任意组合)。
- get_keywords_site_structure
- 功能:检索给定域名的网站结构数据,包括与网站页面关联的关键词、层次结构组织以及用于 SEO 优化的相关元数据。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_serp_compare
- 功能:检索两个或多个关键词的搜索引擎结果页面(SERP)比较,提供它们在搜索排名中表现的见解。
- 输入参数:
keyword(字符串):请求的关键词。period(字符串):SERP 的比较周期(1 个月、3 个月、6 个月、12 个月、自定义)。
- get_keywords_serp_availableDates
- 功能:检索给定关键词在给定时间段内的历史 SERP 数据的可用日期。
- 输入参数:
keyword(字符串):请求的关键词。
- get_keywords_serp_pageEvolution
- 功能:检索特定关键词的 SERP 排名随时间的演变,显示页面在搜索结果中的位置如何变化。
- 输入参数:
keyword(字符串):请求的关键词。first_date(字符串):格式为 YYYY - MM - DD 的日期。second_date(字符串):格式为 YYYY - MM - DD 的日期。url(字符串)
- get_keywords_bulk
- 功能:通过批量请求一次性检索多个关键词的关键词数据。
- 输入参数:
keywords(字符串数组):包含请求关键词的数组。
- get_keywords_scrap
- 功能:通过抓取给定关键词的搜索引擎结果页面(SERP)来检索关键词数据。
- 输入参数:
keywords(字符串数组):包含请求关键词的数组。
3. 网站探索工具
- get_domains_overview
- 功能:检索特定域名的全面 SEO 性能摘要。
- 输入参数:
input(字符串):请求的 URL、域名或根域名。requested_data(字符串数组):请求的给定 URL 或域名的数据,对应于 Haloscan 概述页面不同部分的内容。
- get_domains_positions
- 功能:检索指定域名在一个或多个关键词上的搜索引擎排名位置。
- 输入参数:
input(字符串):请求的 URL、域名或根域名。
- get_domains_top_pages
- 功能:根据自然搜索指标(如流量、排名关键词数量和可见性)检索指定域名的表现最佳的页面。
- 输入参数:
input(字符串):请求的 URL、域名或根域名。
- get_domains_history_positions
- 功能:检索特定域名在选定关键词上的历史排名位置。
- 输入参数:
input(字符串):请求的 URL 或域名。date_from(字符串):格式为 YYYY - MM - DD 的日期。date_to(字符串):格式为 YYYY - MM - DD 的日期。
- get_domains_history_pages
- 功能:检索指定域名的顶级页面的历史 SEO 性能数据。
- 输入参数:
input(字符串):请求的 URL 或域名。date_from(字符串):格式为 YYYY - MM - DD 的日期。date_to(字符串):格式为 YYYY - MM - DD 的日期。
- get_page_best_keywords
- 功能:检索特定 URL 的表现最佳的关键词,显示哪些搜索查询为该页面带来最多流量和可见性。
- 输入参数:
input(字符串数组):请求的 URL 列表。
- get_domains_keywords
- 功能:检索一个域名在自然搜索结果中排名的所有关键词,以及它们的相关指标(如排名位置、流量和搜索量)。
- 输入参数:
input(字符串):请求的 URL 或域名。keywords(字符串数组):包含请求关键词的数组。
- get_domains_bulk
- 功能:在单个请求中检索多个域名的 SEO 性能指标。
- 输入参数:
inputs(字符串数组):包含请求的 URL 或域名的数组。
- get_domains_competitors
- 功能:根据重叠关键词检索给定域名的自然搜索竞争对手列表。
- 输入参数:
input(字符串):请求的 URL 或域名。
- get_domains_competitors_keywords_diff
- 功能:比较给定域名与其竞争对手之间的关键词差异,突出显示一个域名排名而另一个域名未排名的关键词。
- 输入参数:
input(字符串):请求的 URL 或域名。competitors(字符串数组):要与输入进行比较的竞争对手列表。
- get_domains_competitors_best_pages
- 功能:检索给定域名的竞争对手的表现最佳的页面。
- 输入参数:
input(字符串):请求的 URL 或域名。competitors(字符串数组):要与输入进行比较的竞争对手列表。
- get_domains_competitors_keywords_best_positions
- 功能:检索给定域名与其竞争对手相比排名最佳的关键词。
- 输入参数:
competitors(字符串数组):竞争对手域名或根域名列表。keywords(字符串数组):要查找的关键词列表。
- get_domains_visibility_trends
- 功能:检索特定域名随时间的可见性趋势,显示其搜索引擎可见性如何演变。
- 输入参数:
input(字符串数组):包含请求的 URL 或域名的数组。
- get_domains_expired
- 功能:检索特定域名随时间的可见性趋势,显示其搜索引擎可见性如何演变。
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫