Mike MCP Template

mikes mcp模板

用于Surfer SEO集成的MCP服务器模板

⚠️ 重要的SurferSEO API信息 - 认证：大多数请求都需要API密钥。联系 support@surferseo.com 以获得一个。所有请求都必须通过HTTPS进行。 - 无沙箱：有 无沙盒环境 用于测试。您运行的任何API查询都将计入您的实时帐户限制。 - 网络钩子：Webhooks可用于SurferAI查询状态或内容分数更改等事件。要进行设置，您需要一个HTTPS端点，其响应为 200 OK.验证通过 Verification-Key 头球

MCP服务器开发约定

• 对所有顶级模式使用z.object。
• 导出处理程序签名的推断类型：类型Input=z.infer.
• 更喜欢窄类型（例如url:z.string（）.url（））。
• 在边界验证；快速失败；为了用户体验清晰，返回扁平化错误。
• 保持实施最小化和重点突出；在createTool/createPrompt中集中复杂性。

*此MCP旨在在Claude桌面应用程序上本地运行*

工具

• 示例工具：返回所提供消息的示例工具。用您的实际工具实现替换它。
• 获取条款：从Surfer SEO内容编辑器获取NLP术语和关键字。返回用于SEO优化的术语，并为NLP术语和标题术语提供过滤选项。
• 获取结构指南：从Surfer SEO内容编辑器获取结构指南，包括推荐的字数、标题数、段落数和图像计数范围。
• 获取内容：从Surfer SEO内容编辑器获取HTML内容。返回当前正在编辑的文章内容。
• 更新内容：将更新的HTML内容推送到Surfer SEO内容编辑器。在使用NLP术语优化内容后使用此功能。

提示

• seo指南：从Surfer内容编辑器（按ID）中获取结构指南和NLP术语，并将其呈现在工件中。
• 优化内容：从Surfer中提取内容、结构指南和NLP术语，优化内容，并将更新推回到编辑器。

资源

• 当前日期 (time://current)：获取当前日期和时间作为结构化JSON数据。

安装

1. 克隆存储库：

   git clone https://github.com/yourusername/mikes-mcp-template.git
   cd mikes-mcp-template

1. 安装依赖项：

   npm install

1. 构建项目：

   npm run build

配置

1.环境变量

复制示例环境文件并添加您的值：

cp .env.example .env

编辑 .env 并设置您的Surfer SEO API密钥：

SURFER_API_KEY=your_surfer_api_key_here

从获取API密钥 App.surferseo.com.

2.克劳德桌面配置

将服务器添加到Claude Desktop配置文件中：

窗户： %APPDATA%\Claude\claude_desktop_config.json macOS： ~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mikes-mcp-template": {
      "command": "node",
      "args": ["C:\\path\\to\\mikes-mcp-template\\dist\\index.js"],
      "env": {
        "SURFER_API_KEY": "your_surfer_api_key_here"
      }
    }
  }
}

*注：更换 C:\\path\\to\\mikes-mcp-template 使用项目目录的实际绝对路径。*

*重新启动Claude Desktop以应用更改。*

项目结构

mikes-mcp-template/
├── src/
│   ├── index.ts           # Main entry point, registers tools/prompts/resources
│   ├── surfer-client.ts   # Surfer SEO API client utility
│   ├── schemas/
│   │   ├── tooling.ts     # Tool definition helpers and types
│   │   └── prompts.ts     # Prompt definition helpers and types
│   ├── tools/
│   │   ├── index.ts       # Tool exports and registration array
│   │   ├── example-tool.ts # Example tool implementation
│   │   ├── get-terms.ts   # Surfer SEO get-terms tool
│   │   ├── get-structural-guidelines.ts # Surfer SEO structural guidelines tool
│   │   ├── get-content.ts # Surfer SEO get content tool
│   │   └── update-content.ts # Surfer SEO update content tool
│   └── prompts/
│       ├── index.ts       # Prompt exports and registration array
│       ├── example-prompt.ts # SEO guidelines prompt
│       └── optimize-content.ts # Full optimization workflow prompt
├── dist/                  # Compiled JavaScript output
├── package.json
├── tsconfig.json
├── .env.example
├── .gitignore
└── README.md

添加新工具

1. 在中创建新文件 src/tools/ （例如。， my-tool.ts)
2. 使用Zod定义输入模式
3. 使用 createTool() 创建工具定义
4. 导出工具并将其添加到 src/tools/index.ts

例子：

import { z } from "zod";
import { createTool } from "../schemas/tooling";

const InputSchema = z.object({
  param: z.string().describe("Parameter description"),
});

export const myTool = createTool({
  name: "my-tool",
  description: "What my tool does",
  inputSchema: InputSchema,
  async handler(args) {
    // Your implementation
    return {
      content: [{ type: "text", text: "Result" }],
    };
  },
});

添加新提示

1. 在中创建新文件 src/prompts/ （例如。， my-prompt.ts)
2. 使用Zod定义变量模式
3. 使用 createPrompt() 创建提示定义
4. 导出提示并将其添加到 src/prompts/index.ts

例子：

import { z } from "zod";
import { createPrompt } from "../schemas/prompts";

const VarsSchema = z.object({
  topic: z.string().describe("The topic"),
});

export const myPrompt = createPrompt({
  name: "my_prompt",
  description: "What my prompt does",
  varsSchema: VarsSchema,
  handler: async ({ topic }) => {
    return {
      messages: [
        {
          role: "user",
          content: { type: "text", text: `Content about ${topic}` },
        },
      ],
    };
  },
});

______________________________________________________________________