该项目提供了一个模型上下文协议(MCP)服务器,该服务器连接AI助手与SEO API,用于反向链接分析、关键词研究和流量分析。
本项目与项目中使用的任何API无关。您需要一个CAPSOLVER API密钥来解决Ahrefs的验证码问题。
Bearer <token>)# 分析网站流量
npm run dev:cli -- get-traffic --domain "example.com"
# 等同于
npm run dev:cli -- get-traffic --domain "example.com" --mode "子域"
# 分析特定国家的网站流量
npm run dev:cli -- get-traffic --domain "example.com" --mode "精确" --country "uk"
# 获取域名的反向链接
npm run dev:cli -- get-backlinks --domain "example.com"
# 生成关键词想法
npm run dev:cli -- keyword-generator --keyword "seo工具" --country "us"
# 使用特定搜索引擎生成关键词想法
npm run dev:cli -- keyword-generator --keyword "seo工具" --country "us" --search-engine "Google"
# 检查关键词难度
npm run dev:cli -- keyword-difficulty --keyword "seo分析" --country "us"
对于本地配置使用stdio传输:
{
"mcpServers": {
"seo-insights": {
"command": "node",
"args": ["/path/to/seo-insights-mcp-server/dist/index.js"],
"transportType": "stdio"
}
}
}
对于远程HTTP配置:
{
"mcpServers": {
"seo-insights": {
"type": "http",
"url": "http://localhost:8080/mcp"
}
}
}
HTTP传输的环境变量:
您可以使用这些环境变量配置HTTP服务器:
MCP_HTTP_HOST: 绑定到的主机(默认:127.0.0.1)MCP_HTTP_PORT: 监听的端口(默认:8080)MCP_HTTP_PATH: 端点路径(默认:/mcp)模型上下文协议(MCP)是一个开放标准,允许AI系统安全且有上下文地连接外部工具和数据源。
此样板实现了MCP规范,具有清晰分层的架构,可以扩展以构建针对任何API或数据源的自定义MCP服务器。
# 克隆仓库
git clone https://github.com/mrgoonie/seo-insights-mcp-server.git
cd seo-insights-mcp-server
# 安装依赖
npm install
在开发模式下启动服务器,默认使用stdio传输方式:
npm run dev:server
或者使用流式HTTP传输方式:
npm run dev:server:http
这将启动具有热重载的MCP服务器,并在http://localhost:5173启用MCP Inspector。
⚙️ 代理服务器监听端口6277 🔍 MCP Inspector正在运行于http://127.0.0.1:6274
当使用HTTP传输时,默认情况下服务器将在http://127.0.0.1:8080/mcp可用。
使用命令行界面测试各种SEO工具:
# 获取域名的反向链接
npm run dev:cli -- get-backlinks --domain "example.com"
# 生成关键词想法
npm run dev:cli -- generate-keywords --keyword "seo工具" --country "us"
# 检查关键词难度
npm run dev:cli -- check-keyword-difficulty --keyword "seo分析" --country "us"
# 分析网站流量
npm run dev:cli -- get-traffic --domain "example.com" --mode "子域"
{
"keyword": "seo分析",
"difficulty": 72,
"volume": 1200,
"cpc": 5.25,
"serp": [
{
"position": 1,
"title": "SEO分析:完整指南",
"url": "https://example.com/seo-analysis-guide",
"domain": "example.com"
},
{
"position": 2,
"title": "2025年顶级10款SEO分析工具",
"url": "https://example.com/seo-analysis-tools",
"domain": "example.com"
}
]
}
{
"domain": "example.com",
"organicTraffic": 125000,
"paidTraffic": 15000,
"topPages": [
{
"url": "https://example.com/blog/seo-guide",
"traffic": 12500,
"keywords": 145
},
{
"url": "https://example.com/tools/keyword-research",
"traffic": 8700,
"keywords": 98
}
],
"trafficTrend": "增加",
"growthRate": 15.4
}
此样板遵循清晰分层的架构模式,分离关注点并促进可维护性。
src/
├── cli/ # 命令行接口
├── controllers/ # 业务逻辑
├── resources/ # MCP资源:从您的服务器向LLMs暴露数据和内容
├── services/ # 外部API交互
├── tools/ # MCP工具定义
├── types/ # 类型定义
├── utils/ # 共享实用程序
└── index.ts # 入口点
src/cli/*.cli.ts)<特性>.cli.ts<特性>.cli.test.tssrc/tools/*.tool.ts)<特性>.tool.ts,类型在<特性>.types.tssrc/controllers/*.controller.ts)<特性>.controller.tsControllerResponse对象src/services/*.service.ts)<特性>.service.tssrc/utils/*.util.ts)logger.util.ts: 结构化日志记录error.util.ts: 错误处理和标准化formatter.util.ts: Markdown格式化助手# 在开发模式下启动服务器(热重载及检查器)
npm run dev:server
# 在开发模式下运行命令行界面
npm run dev:cli -- [命令] [参数]
# 构建项目
npm run build
# 在生产模式下启动服务器
npm run start:server
# 在生产模式下运行命令行界面
npm run start:cli -- [命令] [参数]
# 运行所有测试
npm test
# 运行特定测试
npm test -- src/path/to/test.ts
# 生成测试覆盖率报告
npm run test:coverage
# 检查代码
npm run lint
# 使用Prettier格式化代码
npm run format
# 检查类型
npm run typecheck
按照以下步骤将您自己的工具添加到服务器:
在src/services/中创建一个新的服务以与您的外部API交互:
// src/services/example.service.ts
import { Logger } from '../utils/logger.util.js';
const logger = Logger.forContext('services/example.service.ts');
export async function getData(param: string): Promise<any> {
logger.debug('获取数据', { param });
// API交互代码在此处
return { result: '示例数据' };
}
在src/controllers/中添加一个控制器以处理业务逻辑:
// src/controllers/example.controller.ts
import { Logger } from '../utils/logger.util.js';
import * as exampleService from '../services/example.service.js';
import { formatMarkdown } from '../utils/formatter.util.js';
import { handleControllerError } from '../utils/error-handler.util.js';
import { ControllerResponse } from '../types/common.types.js';
const logger = Logger.forContext('controllers/example.controller.ts');
export interface GetDataOptions {
param?: string;
}
export async function getData(
options: GetDataOptions = {},
): Promise<ControllerResponse> {
try {
logger.debug('使用选项获取数据', options);
const data = await exampleService.getData(options.param || '默认值');
const content = formatMarkdown(data);
return { content };
} catch (error) {
throw handleControllerError(error, {
entityType: '示例数据',
操作: 'getData',
来源: 'controllers/example.controller.ts',
});
}
}
在src/tools/中创建一个工具定义:
// src/tools/example.tool.ts
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
import { z } from 'zod';
import { Logger } from '../utils/logger.util.js';
import { formatErrorForMcpTool } from '../utils/error.util.js';
import * as exampleController from '../controllers/example.controller.js';
const logger = Logger.forContext('tools/example.tool.ts');
const GetDataArgs = z.object({
param: z.string().optional().describe('可选参数'),
});
type GetDataArgsType = z.infer<typeof GetDataArgs>;
async function handleGetData(args: GetDataArgsType) {
try {
logger.debug('工具get_data被调用', args);
const result = await exampleController.getData({
param: args.param,
});
return {
content: [{ type: 'text' as const, text: result.content }],
};
} catch (error) {
logger.error('工具get_data失败', error);
return formatErrorForMcpTool(error);
}
}
export function register(server: McpServer) {
server.tool(
'get_data',
`从示例API获取数据,可选使用\`param\`。
使用此工具获取示例数据。返回格式化的Markdown数据。`,
GetDataArgs.shape,
handleGetData,
);
}
在src/cli/中创建一个命令行命令:
// src/cli/example.cli.ts
import { program } from 'commander';
import { Logger } from '../utils/logger.util.js';
import * as exampleController from '../controllers/example.controller.js';
import { handleCliError } from '../utils/error-handler.util.js';
const logger = Logger.forContext('cli/example.cli.ts');
program
.command('get-data')
.description('获取示例数据')
.option('--param <值>', '可选参数')
.action(async (选项) => {
try {
logger.debug('CLI get-data被调用', 选项);
const result = await exampleController.getData({
param: 选项.param,
});
console.log(result.content);
} catch (error) {
handleCliError(error);
}
});
更新入口点以注册新的组件:
// 在src/cli/index.ts中
import '../cli/example.cli.js';
// 在src/index.ts(对于工具)
import exampleTool from './tools/example.tool.js';
// 然后在registerTools函数中:
exampleTool.register(server);
访问可视化MCP检查器以测试您的工具并查看请求/响应详细信息:
npm run dev:server为开发启用调试日志:
# 设置环境变量
DEBUG=true npm run dev:server
# 或在~/.mcp/configs.json中配置
准备发布您的自定义MCP服务器时:
npm run buildnpm run start:servernpm publish{
"seo-insights": {
"environments": {
"DEBUG": "true",
"CAPSOLVER_API_KEY": "您的API密钥"
}
}
}
注意:为了兼容性,如果未找到seo-insights键,服务器还将识别完整包名(seo-insights-mcp-server)或无范围包名(seo-insights-mcp-server)下的配置。然而,建议新配置使用短seo-insights键。