Communitygithub.com

DataShrimp/skills

构建高质量 MCP(模型上下文协议)服务器的指南,使 LLM 能够通过精心设计的工具与外部服务交互。在构建 MCP 服务器以集成外部 API 或服务时使用,支持 Python(FastMCP)或 Node/TypeScript(MCP SDK)。

skills 是什么?

此技能提供了一个全面的指南,用于构建高质量的 MCP(模型上下文协议)服务器,使 LLM 能够通过结构化工具与外部 API 和服务无缝交互。它涵盖了一个详细的分阶段工作流,从深入研究和规划(包括 API 覆盖与工作流工具的平衡、工具命名和错误处理)开始,通过 SDK 设置和工具实现继续,再到回顾和测试,并最终创建评估以验证 LLM 的有效性。支持 TypeScript(推荐)和 Python,该指南强调了清晰、可发现的工具定义、完善的输入/输出模式、正确的注释(如 readOnlyHint 和 destructiveHint)以及分页和上下文管理等最佳实践。此技能还包括其他技能工程范例,例如 Claude Code 的动态上下文注入、OpenAI 的侧车模式以及用于自动化工作流的自包含 Python 脚本规范。

兼容平台✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/DataShrimp/skills/tree/HEAD/MetaPrompt/02-official-and-frameworks/anthropic-mcp-builder

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

源出处


第 1 部分:Anthropic 官方 mcp-builder/SKILL.md (3 级渐进式披露范例)

概述

创建 MCP(模型上下文协议)服务器,使 LLM 能够通过精心设计的工具与外部服务交互。MCP 服务器的质量取决于它使 LLM 完成实际任务的能力。


流程

🚀 高级工作流

创建高质量的 MCP 服务器涉及四个主要阶段:

阶段 1:深入研究和规划

1.1 理解现代 MCP 设计

API 覆盖 vs. 工作流工具: 在全面的 API 端点覆盖与专门的工作流工具之间取得平衡。工作流工具对于特定任务可能更方便,而全面的覆盖则赋予代理灵活组合操作的能力。性能因客户端而异——某些客户端受益于组合基本工具的代码执行,而其他客户端则更适合高级工作流。如果不确定,优先考虑全面的 API 覆盖。

工具命名与可发现性: 清晰、描述性的工具名称有助于代理快速找到合适的工具。使用一致的前缀(例如 github_create_issue、github_list_repos)和面向操作的命名。

上下文管理: 代理受益于简洁的工具描述以及过滤/分页结果的能力。设计能够返回集中、相关数据的工具。某些客户端支持代码执行,这可以帮助代理高效地过滤和处理数据。

可操作的错误消息: 错误消息应通过具体的建议和后续步骤引导代理找到解决方案。

1.2 学习 MCP 协议文档

浏览 MCP 规范: 从站点地图开始,查找相关页面:https://modelcontextprotocol.io/sitemap.xml 然后使用 .md 后缀获取特定页面(例如 https://modelcontextprotocol.io/specification/draft.md)。

需要查看的关键页面:

  • 规范概述和架构
  • 传输机制(可流式 HTTP、stdio)
  • 工具、资源和提示定义

1.3 学习框架文档

推荐技术栈:

  • 语言: TypeScript(高质量的 SDK 支持,在许多执行环境(如 MCPB)中具有良好的兼容性。此外,AI 模型擅长生成 TypeScript 代码,得益于其广泛使用、静态类型和良好的 linting 工具)
  • 传输: 远程服务器使用可流式 HTTP,采用无状态 JSON(比有状态会话和流式响应更易于扩展和维护)。本地服务器使用 stdio。

加载框架文档:

1.4 规划你的实现

理解 API: 查看服务的 API 文档以确定关键端点、身份验证要求和数据模型。根据需要执行网络搜索和网络获取。

工具选择: 优先考虑全面的 API 覆盖。列出要实现的端点,从最常见的操作开始。


阶段 2:实现

2.1 设置项目结构

有关项目设置,请参阅特定语言的指南:

2.2 实现核心基础设施

创建共享实用程序:

  • 带有身份验证的 API 客户端
  • 错误处理帮助程序
  • 响应格式化(JSON 和 Markdown)
  • 分页支持

2.3 实现工具

对于每个工具:

输入模式:

  • 使用 Zod(TypeScript)或 Pydantic(Python)
  • 包含约束条件和清晰描述
  • 在字段描述中添加示例

输出模式:

  • 尽可能定义 outputSchema 以获取结构化数据
  • 在工具响应中使用 structuredContent(TypeScript SDK 功能)
  • 帮助客户端理解和处理工具输出

工具描述:

  • 功能简洁总结
  • 参数描述
  • 返回值模式

实现:

  • 使用 async/await 处理 I/O 操作
  • 使用带有可操作消息的适当错误处理
  • 在适用情况下支持分页
  • 使用现代 SDK 时,返回文本内容和结构化数据

注释:

  • readOnlyHint: true/false
  • destructiveHint: true/false
  • idempotentHint: true/false
  • openWorldHint: true/false

阶段 3:审查和测试

3.1 代码质量

检查事项:

  • 没有重复代码(DRY 原则)
  • 一致的错误处理
  • 完整的类型覆盖
  • 清晰明了的工具描述

3.2 构建和测试

TypeScript:

  • 运行 npm run build 以验证编译
  • 使用 MCP Inspector 进行测试:npx @modelcontextprotocol/inspector

Python:

  • 验证语法:python -m py_compile your_server.py
  • 使用 MCP Inspector 进行测试

有关详细的测试方法和质量检查清单,请参阅特定语言的指南。


阶段 4:创建评估

在实现 MCP 服务器之后,创建全面的评估以测试其有效性。

加载 ✅ 评估指南 获取完整的评估指南。

4.1 理解评估目的

使用评估来测试 LLM 是否能够有效地使用你的 MCP 服务器来回答现实、复杂的问题。

4.2 创建 10 个评估问题

要创建有效的评估,请遵循评估指南中概述的流程:

  1. 工具检查: 列出可用的工具并了解其功能
  2. 内容探索: 使用只读操作探索可用数据
  3. 问题生成: 创建 10 个复杂、现实的问题
  4. 答案验证: 自己解决每个问题以验证答案

4.3 评估要求

确保每个问题:

  • 独立: 不依赖其他问题
  • 只读: 仅需要非破坏性操作
  • 复杂: 需要多次工具调用和深入探索
  • 现实: 基于用户关心的实际用例
  • 可验证: 可以通过字符串比较验证的单个清晰答案
  • 稳定: 答案不会随时间变化

4.4 输出格式

创建具有以下结构的 XML 文件:

<evaluation>
  <qa_pair>
    <question>查找有关具有动物代号的人工智能模型发布的讨论。一个模型需要特定的安全指定,其格式为 ASL-X。对于以斑点野猫命名的模型,确定的数字 X 是多少?</question>
    <answer>3</answer>
  </qa_pair>
<!-- 更多 qa_pairs... -->
</evaluation>

参考文件

📚 文档库

在开发过程中根据需要加载这些资源:

核心 MCP 文档(首先加载)

  • MCP 协议: 从站点地图 https://modelcontextprotocol.io/sitemap.xml 开始,然后使用 .md 后缀获取特定页面
  • 📋 MCP 最佳实践 - 通用 MCP 指南,包括:
    • 服务器和工具命名约定
    • 响应格式指南(JSON vs Markdown)
    • 分页最佳实践
    • 传输选择(可流式 HTTP vs stdio)
    • 安全性和错误处理标准

SDK 文档(在阶段 1/2 期间加载)

  • Python SDK: 从 https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md 获取
  • TypeScript SDK: 从 https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md 获取

特定语言的实现指南(在阶段 2 期间加载)

评估指南(在阶段 4 期间加载)


第 2 部分:Claude Code 动态上下文注入 (!command``) 技能范例

---
name: pr-summary
description: 总结拉取请求中的更改。当用户要求审查、总结或审计当前 PR 或分支差异时使用。
context: fork
agent: Explore
allowed-tools: Bash(gh *)
---

## 拉取请求上下文
- PR 差异: !`gh pr diff`
- PR 评论: !`gh pr view --comments`
- 更改的文件: !`gh pr diff --name-only`

## 你的任务
总结此拉取请求,包含具体的文件级风险、破坏性更改和验证步骤...

第 3 部分:OpenAI Codex / ChatGPT agents/openai.yaml 侧车模式

interface:
  display_name: "自我进化元提示与角色架构师"
  short_description: "跨工具编译、评估和调整提示、技能和代理角色"
  icon_small: "./assets/icon-small.svg"
  icon_large: "./assets/icon-large.png"
  brand_color: "#2563EB"
  default_prompt: "使用评估评分卡设计或优化提示、技能或代理角色定义。"

policy:
  allow_implicit_invocation: true

dependencies:
  tools:
    - type: "mcp"
      value: "git"
      description: "用于仓库检查的 Git MCP 服务器"

第 4 部分:代理技能 PEP 723 自包含脚本框架范例

# /// script
# dependencies = [
#   "pydantic>=2.0",
# ]
# requires-python = ">=3.10"
# ///
"""旨在通过 `uv run` 为代理技能调用设计的自包含非交互式 CLI 脚本。"""

import argparse
import json
import sys


def main() -> int:
    parser = argparse.ArgumentParser(
        description="无需交互提示即可验证技能或角色头部元数据和令牌预算。"
    )
    parser.add_argument("--input", required=True, help="目标 Markdown 文件的路径")
    parser.add_argument("--max-chars", type=int, default=12000, help="字符预算上限")
    parser.add_argument("--dry-run", action="store_true", help="预览检查而不写入")
    args = parser.parse_args()

    try:
        with open(args.input, "r", encoding="utf-8") as f:
            text = f.read()
    except FileNotFoundError:
        sys.stderr.write(
            f"错误:未找到文件 '{args.input}'。请通过 --input <path> 传递有效路径。\n"
        )
        return 1

    char_count = len(text)
    passed = char_count <= args.max_chars
    result = {
        "file": args.input,
        "char_count": char_count,
        "max_chars": args.max_chars,
        "passed": passed,
        "remediation": None if passed else f"减少 {char_count - args.max_chars} 个字符或将详细信息移至 references/。",
    }
    sys.stdout.write(json.dumps(result, ensure_ascii=False, indent=2) + "\n")
    return 0 if passed else 2


if __name__ == "__main__":
    sys.exit(main())

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

相关技能