MCP模型卡生成器

为模型上下文协议（MCP）服务器生成标准化文档。

🚀 快速开始

![Open In Colab](https://colab.research.google.com/drive/16sWdvROQ4GoP7-IixtCcjx9PSvEsSj8n?usp=sharing)

点击上面的徽章开始生成您的模特卡！

✨ 特性

基于表单的交互式界面
生成两者 JSON（机器可读）和Markdown（人类可读）
跟随 MCP型号卡规范v1.0
完成用户指南举例说明
例子： Brave Search MCP服务器型号卡

📖 文档

用户指南 -完整的教程，解释每个领域
规格 -技术规格
示例 -真实模型卡示例

💙 学分

*W3C AI-KR社区小组在人工智能代理互操作性和透明度方面的工作的一部分。*

MCP模型卡生成器-完整的用户指南和MCP教程

版本: 1.0.0\ 概念：Paola Di Maio，W3C AI-KR CG主席\ 笔记本由：克劳德（人类学）

______________________________________________________________________

什么是模型卡？

A. 模型卡 是标准化的文档，描述了MCP服务器的功能、工作原理以及如何安全使用它。把它想象成服务器的“营养标签”——它告诉用户他们得到了什么。

为什么要创建一个？

使您的服务器可被发现
帮助用户了解功能和限制
启用自动兼容性检查
通过透明度建立信任
许多MCP注册表都需要

______________________________________________________________________

开始之前

您需要什么：

您的MCP服务器代码（或访问其文档）
了解服务器暴露的工具
安全/身份验证要求
15-30分钟

有用的有：

您服务器的GitHub存储库URL
所需环境变量列表
性能基准（如有）
测试覆盖率统计数据（如果可用）

______________________________________________________________________

逐节指南

______________________________________________________________________

📝 第1节：服务器元数据

本节标识您的服务器并提供基本信息。

服务器名称（必填）

它是什么：您的MCP服务器的正式名称
格式：纯文本，描述性
例子:

- ✅ “GitHub MCP服务器” - ✅ “Brave Search MCP服务器” - ✅ “PostgreSQL数据库MCP服务器” - ❌ “我的服务器”（太模糊） - ❌ “Server123”（非描述性）

版本（必填）

它是什么：服务器的版本号
格式：语义版本控制（major.minor.patch）
例子:

- ✅ “1.0.0”（第一个稳定版本） - ✅ “2.3.1”（版本2，更新3，补丁1） - ✅ “0.9.0测试版”（预发布） - ❌ “版本1”（格式不正确） - ❌ “最新”（不具体）

描述（必填）

它是什么：服务器功能的简要概述
格式：10-500个字符，一个或两个句子
要包括什么：主要目的、主要特点
例子:

- ✅ “用于GitHub API集成的MCP服务器，提供存储库管理、问题跟踪和提取请求操作” - ✅ “具有可配置访问控制和目录限制的安全文件操作服务器” - ❌ “服务器”（太模糊） - ❌ \[500+字的文章\]（太长）

MCP协议版本（必填）

它是什么：您的服务器实现了哪个版本的MCP规范
格式：从下拉列表中选择
选项:

- 2025-11-25 -最新稳定版本（建议用于新服务器） - 2025-06-18 -稳定 - 2024-11-05 -遗产 - other -如果使用其他版本

如何知道：检查服务器的package.json或文档

作者（可选）

它是什么：您的姓名或用户名
格式：纯文本
例子:

- ✅ “约翰·史密斯” - ✅ “简·戴” - ✅ “AI研究团队”

组织（可选）

它是什么：创建服务器的公司或组
格式：纯文本
例子:

- ✅ “人类学” - ✅ “Mozilla基金会” - ✅ “OpenAI” - 如果是个人开发人员，请留空

许可证（必填）

它是什么：服务器的软件许可证
格式：标准许可证标识符
常用选项:

- MIT -非常宽容，最常见 - Apache-2.0 -具有专利保护的许可 - GPL-3.0 -Copyleft，要求衍生作品开源 - BSD-3-Clause -允许归因 - Proprietary -闭源

如何知道：检查您的LICENSE文件或GitHub存储库

仓库地址（可选）

它是什么：链接到服务器的源代码
格式：以https开头的完整URL：//
例子:

- ✅ "https://github.com/username/mcp-server" - ✅ "https://gitlab.com/org/mcp-server" - 如果来源封闭，请留空

语言（必填）

它是什么：主要编程语言
选项:

- typescript -Types/JavaScript - python python - javascript -纯JavaScript - java Java - other -其他语言

运输（必填）

它是什么：服务器支持的通信方式
格式：选择所有适用项
选项:

- stdio -标准输入/输出（最常见） - http+sse -HTTP与服务器发送的事件

如何知道：检查服务器的配置或启动代码

标签（可选）

它是什么：帮助人们找到您的服务器的关键字
格式：逗号分隔的单词（小写，单个标记中没有空格）
例子:

- ✅ github、api、版本控制、开发工具 - ✅ 数据库、postgresql、sql - ✅ “搜索，勇敢，网络搜索” - ❌ “GitHub API”（请改用GitHub、API）

______________________________________________________________________

🔧 第2节：工具文档

本节记录了服务器公开的每个工具（功能）。

您将为服务器提供的每个工具添加一个条目。

工具名称（必填）

它是什么：客户端将调用的确切函数名
格式: service_action_resource （全部小写，下划线）
例子:

- ✅ github_list_repositories - ✅ slack_send_message - ✅ postgres_execute_query - ❌ listRepos （格式错误-camelCase） - ❌ get_data （过于笼统） - ❌ tool1 （非描述性）

为什么这很重要：MCP一致性命名约定

工具说明（必填）

它是什么：这个特定的工具做什么
格式：一两个清晰的句子
例子:

- ✅ “列出经过身份验证的用户或指定组织的所有存储库” - ✅ “向指定的Slack频道发送消息” - ✅ “对数据库执行只读SQL查询” - ❌ “获取内容”（过于模糊）

输入模式（必填）

它是什么：JSON模式定义此工具接受哪些参数
格式：有效的JSON模式（粘贴到文本框中）
最小结构:

{
  "type": "object",
  "properties": {},
  "required": []
}

带参数的示例:

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "GitHub username"
    },
    "limit": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "default": 10,
      "description": "Number of results to return"
    },
    "include_private": {
      "type": "boolean",
      "default": false,
      "description": "Include private repositories"
    }
  },
  "required": ["username"]
}

常见财产类型:

"type": "string" -文本
"type": "number" -数值
"type": "boolean" -正确/错误
"type": "array" -项目清单
"type": "object" -嵌套结构

常见约束:

"minimum": 1 -数字的最小值
"maximum": 100 -数字的最大值
"minLength": 1 -最小字符串长度
"maxLength": 500 -最大字符串长度
"enum": ["option1", "option2"] -允许值列表
"default": value -如果未提供默认值

输出模式（必填）

它是什么：JSON模式定义此工具返回的内容
格式：有效的JSON架构
示例:

{
  "type": "object",
  "properties": {
    "repositories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {"type": "string"},
          "url": {"type": "string"},
          "stars": {"type": "number"}
        }
      }
    },
    "total_count": {
      "type": "number"
    }
  }
}

⚠️ 破坏性操作（必填-复选框）

它是什么：此工具是否删除、修改或更改数据？
何时检查：如果工具：

- 删除文件、记录或资源 - 修改现有数据 - 创建不可逆的更改 - 执行系统命令

例子:

- ✅ 检查： github_delete_repository - ✅ 检查： file_write_content - ✅ 检查： database_drop_table - ❌ 取消选中： github_list_repositories （只读） - ❌ 取消选中： slack_read_messages （只读）

只读操作（必填-复选框）

它是什么：此工具是否只读取/检索数据而不更改任何内容？
何时检查：如果仅使用工具：

- 获取/检索信息 - 搜索或查询 - 列出或显示数据

例子:

- ✅ 检查： database_select_query - ✅ 检查： github_get_repository_info - ❌ 取消选中： github_create_issue （创建数据）

异步操作（必填-复选框）

它是什么：此工具是否异步运行（可能需要时间）？
何时检查：如果工具：

- 发出网络请求 - 执行I/O操作 - 可能需要超过即时响应时间

大多数工具都应该检查这一点，除非它们纯粹是计算性的

填写一个工具的所有字段后，单击“➕ 添加工具“

对服务器提供的每个工具重复此操作！

______________________________________________________________________

⚡ 第3节：操作特性

本节介绍服务器的性能。

平均响应时间（ms）（必填）

它是什么：服务器响应的典型时间
格式：以毫秒为单位的数字
如何知道:

- 在服务器上运行基准测试 - 或者根据服务器的功能进行估算

典型值:

- 50-100ms -非常快（本地操作、缓存查找） - 100-500ms -快速（数据库查询、简单的API调用） - 500-2000ms -中等（复杂操作、外部API） - 2000+ms -缓慢（处理量大，多次API调用）

例子:

- ✅ 150 （对于数据库服务器） - ✅ 300 （用于API集成） - ✅ 1000 （用于复杂操作）

速率限制-每分钟（必填）

它是什么：每分钟允许的最大请求数
格式：编号
如何知道:

- 检查您是否正在使用外部API（使用其限制） - 根据服务器容量设置自己的限制

典型值:

- 60 -每秒1次 - 300 -每秒5次 - 1000 -每秒约16次 - 5000 -高吞吐量

例子:

- ✅ 60 （GitHub API免费层） - ✅ 1000 （自托管服务器）

费率限制-每小时（必填）

它是什么：每小时允许的最大请求数
格式：编号
典型值:

- 2000 -免费层API - 5000 -基本层 - 50000 -高级级别 - unlimited -使用 999999 如果没有限制

已知限制（必填）

它是什么：你的服务器不能做的事情或它有限制
格式：每行一个限制
要包括什么:

- API等级限制 - 缺少功能 - 尺寸/数量限制 - 兼容性问题

例子:

Free tier limited to 2,000 queries per month
Maximum 100 results per search
Does not support wildcard searches
Requires PostgreSQL 12 or higher
Cannot access private repositories without token
Large file uploads (>10MB) not supported

______________________________________________________________________

🔒 第4节：安全配置文件

本节介绍安全性和身份验证。

身份验证方法（必填）

它是什么：用户如何证明自己的身份
格式：选择所有适用项
选项:

- oauth2 -OAuth 2.0流程 - api_key -API密钥/令牌 - personal_access_token -用户生成的令牌 - none -无需身份验证

例子:

- GitHub服务器： oauth2, personal_access_token - 勇敢的搜索： api_key - 本地文件系统： none

所需范围（可选）

它是什么：需要OAuth作用域或权限
格式：逗号分隔列表
仅在使用OAuth2时才相关
例子:

- ✅ “仓库、用户、管理员：org”（GitHub） - ✅ “drive.readonly，日历.events”（谷歌） - 如果使用API密钥，请保留为空

凭据存储（必填）

它是什么：凭证存储在何处/如何存储
格式：从下拉列表中选择
选项:

- environment_variables -最常见和推荐 - secure_vault -使用秘密管理器 - config_file -在配置文件中（不太安全） - other -其他方法

最佳实践：使用环境变量

数据保留政策（必填）

它是什么：您保留用户数据多长时间
格式：明文清晰表述
例子:

- ✅ “不保留数据；充当无状态代理” - ✅ 查询日志保留7天，然后删除 - ✅ “用户首选项无限期存储，直到帐户删除” - ✅ 会话数据缓存1小时，然后清除

传输中加密的数据（必填-复选框）

它是什么：数据传输时是否加密？
何时检查:

- ✅ 检查是否使用HTTPS/TLS - ✅ 检查所有外部API是否都使用HTTPS - ❌ 如果使用纯HTTP，请取消检查（不建议！）

PII处理（必填）

它是什么：您如何处理个人身份信息
格式：明确声明
例子:

- ✅ “服务器无法访问或存储PII” - ✅ “PII在静止和传输过程中进行加密；30天后删除” - ✅ “经用户同意存储的电子邮件地址；从不与第三方共享” - ✅ “N/A-服务器不处理个人信息”

安全注意事项（必填）

它是什么：用户应该知道的安全警告或风险
格式：每行一个考虑因素
例子:

API keys must be kept secure and never committed to version control
Server has access to all files in configured directories
Destructive operations cannot be undone
Rate limiting enforced by external API
Requires network access to api.github.com

安全最佳实践（必填）

它是什么：安全使用建议
格式：每条线一次练习
例子:

Store credentials in environment variables
Use least-privilege API scopes
Rotate API keys every 90 days
Enable audit logging in production
Review tool permissions before granting access
Monitor API usage through provider dashboard
Use read-only tokens when possible

______________________________________________________________________

🚀 第5节：部署环境

本节帮助用户部署服务器。

预期使用案例（必填）

它是什么：你的服务器有什么用？
格式：每行一个用例
例子:

Automating GitHub repository management
Creating and tracking issues in development workflows
Syncing code between local and remote repositories
Generating project documentation
Managing pull request reviews

超出范围的情况（必填）

它是什么：你的服务器不应该用于什么？
格式：每行一个场景
为什么这很重要：设定适当的期望
例子:

Direct database access or SQL execution
File system operations outside configured directories
Real-time collaboration features
Video or audio processing
Cryptocurrency mining or blockchain operations
Production deployments without proper authentication

最低Node.js版本（可选）

它是什么：所需的最低Node.js版本
格式：版本号
仅当您的服务器使用Node.js/TypeScript时填写
例子:

- ✅ "18.0.0" - ✅ "20.9.0" - ✅ "22.0.0"

最低Python版本（可选）

它是什么：所需的最低Python版本
格式：版本号
仅当您的服务器使用Python时填写
例子:

- ✅ "3.8" - ✅ "3.10" - ✅ "3.11"

环境变量（必填）

它是什么：必须设置哪些环境变量
格式：每行一个，格式： VAR_NAME: description
例子:

GITHUB_TOKEN: Personal access token with repo scope
DATABASE_URL: PostgreSQL connection string
API_KEY: Brave Search API key
MAX_RESULTS: Maximum results per query (default: 10)
LOG_LEVEL: Logging verbosity (debug, info, warn, error)

外部依赖项（必填）

它是什么：服务器所需的外部服务或API
格式：每行一个
例子:

GitHub API (api.github.com)
PostgreSQL database server
Redis cache (optional)
Internet connectivity

如果没有：写“无-完全独立”

积极维护（必填-复选框）

它是什么：您仍在维护/更新此服务器吗？
何时检查:

- ✅ 检查您是否响应问题、更新依赖关系、修复错误 - ❌ 如果存档/弃用，请取消检查

______________________________________________________________________

📊 第6节：评估结果（可选）

本节显示测试和验证结果。

合规性得分（可选）

它是什么：您的服务器遵循MCP规范的程度如何
格式：0-100之间的滑块
如何知道:

- 运行MCP验证器工具 - 或根据测试进行估算

分数含义:

- 90-100：优秀-完全合规 - 70-89：好-小问题 - 50-69：中等-存在一些偏差 - 25-49：差-重大问题 - 0-24：严重-重大违规行为

测试覆盖率（可选）

它是什么：测试覆盖的代码百分比
格式：百分比字符串（例如“85%”）
如何知道：运行 npm test --coverage 或pytest覆盖率

测试通过（可选）

它是什么：通过的测试用例数
格式：编号
示例: 120

测试失败（可选）

它是什么：失败的测试用例数
格式：编号
应: 0 用于生产服务器

______________________________________________________________________

常见问题

Q：如果我不知道一些价值观怎么办？

A.:

必填字段：做出最佳估计或使用占位符值
可选字段：留空-它们不会出现在输出中
未知性能：使用保守估计（更高的响应时间，更低的速率限制）

Q：工具描述应该有多详细？

A.:

足够清楚，不熟悉的人可以理解它的作用
包括关键参数和返回值
1-2个句子是完美的
示例：“按名称、语言或主题搜索GitHub存储库。最多返回100个结果，其中包含存储库元数据，包括星号、叉号和上次更新时间。”

Q：我需要添加所有工具吗？

A.:

是的，需要一张完整的模型卡
但你可以从最重要的工具开始
以后你总是可以用更多的工具重新生成

Q：如果我的服务器有50多个工具怎么办？

A.:

很好！发电机处理它
在规划中考虑将相关工具分组
JSON将包含所有这些内容
Markdown会清楚地列出它们

Q：我可以编辑生成的文件吗？

A.:

对！它们由你修改
JSON是机器可读的-仔细编辑
Markdown是人类可读的，可以自由编辑
如果您同时编辑这两个文件，请保持它们同步

______________________________________________________________________

例子

示例1：简单只读工具

Tool Name: weather_get_forecast
Description: Retrieves 7-day weather forecast for a specified location
Input Schema:
{
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "description": "City name or ZIP code"
    },
    "units": {
      "type": "string",
      "enum": ["fahrenheit", "celsius"],
      "default": "fahrenheit"
    }
  },
  "required": ["location"]
}

Output Schema:
{
  "type": "object",
  "properties": {
    "forecast": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {"type": "string"},
          "high": {"type": "number"},
          "low": {"type": "number"},
          "conditions": {"type": "string"}
        }
      }
    }
  }
}

Destructive: NO (unchecked)
Read-only: YES (checked)
Async: YES (checked)

示例2：破坏性工具

Tool Name: database_delete_record
Description: Permanently deletes a record from the specified table
Input Schema:
{
  "type": "object",
  "properties": {
    "table": {
      "type": "string",
      "description": "Table name"
    },
    "id": {
      "type": "number",
      "description": "Record ID to delete"
    }
  },
  "required": ["table", "id"]
}

Output Schema:
{
  "type": "object",
  "properties": {
    "deleted": {"type": "boolean"},
    "id": {"type": "number"}
  }
}

Destructive: YES (checked) ⚠️
Read-only: NO (unchecked)
Async: YES (checked)

______________________________________________________________________

成功秘诀

开始前：

✅ 打开服务器的README以供参考
✅ 了解您的工具名称及其功能
✅ 为每个工具提供示例输入/输出
✅ 了解您的身份验证方法

填充时：

✅ 按顺序完成各部分
✅ 不要担心完美，你可以再生
✅ 使用本指南中的示例作为模板
✅ 如果不确定，请将可选字段留空

工具文档提示：

✅ 从你最重要的工具开始
✅ 复制/粘贴类似的模式并修改
✅ 添加前验证JSON（如果需要，请使用jsonline.com）
✅ 对破坏性行动要诚实！

生成后：

✅ 查看JSON和Markdown文件
✅ 检查描述中的拼写错误
✅ 验证工具名称是否与实际代码匹配
✅ 添加到您的存储库并发布！

______________________________________________________________________

获取帮助

如果你被卡住了：

查看本指南的示例
查看MCP型号卡规范
查看GitHub上的现有模型卡
在W3C AI-KR社区小组中提问

常见错误：

❌ 使用camelCase作为工具名称（使用snake_case）
❌ 忘记必填字段
❌ 架构中的JSON无效
❌ 未正确标记破坏性工具
❌ 描述过于模糊

______________________________________________________________________

准备好创建模型卡了吗？

打开Colab笔记本，按照本指南逐节进行操作，您将在15-30分钟内获得MCP服务器的专业文档！

______________________________________________________________________

创建于：MCP模型卡生成器v1.0\ 规格：MCP型号卡规范v1.0\ W3C AI-KR社区小组

💙 Claude&Paola用爱建造

MCP Model Card Generator

快速接入

详细介绍

MCP模型卡生成器

🚀 快速开始

✨ 特性

📖 文档

💙 学分

MCP模型卡生成器-完整的用户指南和MCP教程

目录

什么是模型卡？

开始之前

逐节指南

📝 第1节：服务器元数据

服务器名称 （必填）

版本 （必填）

描述 （必填）

MCP协议版本 （必填）

作者 （可选）

组织 （可选）

许可证 （必填）

仓库地址 （可选）

语言 （必填）

运输 （必填）

标签 （可选）

🔧 第2节：工具文档

工具名称 （必填）

工具说明 （必填）

输入模式 （必填）

输出模式 （必填）

⚠️ 破坏性操作 （必填-复选框）

只读操作 （必填-复选框）

异步操作 （必填-复选框）

⚡ 第3节：操作特性

平均响应时间（ms） （必填）

速率限制-每分钟 （必填）

费率限制-每小时 （必填）

已知限制 （必填）

🔒 第4节：安全配置文件

身份验证方法 （必填）

所需范围 （可选）

凭据存储 （必填）

数据保留政策 （必填）

传输中加密的数据 （必填-复选框）

PII处理 （必填）

安全注意事项 （必填）

安全最佳实践 （必填）

🚀 第5节：部署环境

预期使用案例 （必填）

超出范围的情况 （必填）

最低Node.js版本 （可选）

最低Python版本 （可选）

环境变量 （必填）

外部依赖项 （必填）

积极维护 （必填-复选框）

📊 第6节：评估结果（可选）

合规性得分 （可选）

测试覆盖率 （可选）

测试通过 （可选）

测试失败 （可选）

常见问题

Q： 如果我不知道一些价值观怎么办？

Q： 工具描述应该有多详细？

Q： 我需要添加所有工具吗？

Q： 如果我的服务器有50多个工具怎么办？

Q： 我可以编辑生成的文件吗？

例子

示例1：简单只读工具

示例2：破坏性工具

成功秘诀

开始前：

填充时：

工具文档提示：

生成后：

获取帮助

目录标签

接入字段

权限和风险

来源信息

继续浏览同类 MCP

服务器名称（必填）

版本（必填）

描述（必填）

MCP协议版本（必填）

作者（可选）

组织（可选）

许可证（必填）

仓库地址（可选）

语言（必填）

运输（必填）

标签（可选）

工具名称（必填）

工具说明（必填）

输入模式（必填）

输出模式（必填）

⚠️ 破坏性操作（必填-复选框）

只读操作（必填-复选框）

异步操作（必填-复选框）

平均响应时间（ms）（必填）

速率限制-每分钟（必填）

费率限制-每小时（必填）

已知限制（必填）

身份验证方法（必填）

所需范围（可选）

凭据存储（必填）

数据保留政策（必填）

传输中加密的数据（必填-复选框）

PII处理（必填）

安全注意事项（必填）

安全最佳实践（必填）

预期使用案例（必填）

超出范围的情况（必填）

最低Node.js版本（可选）

最低Python版本（可选）

环境变量（必填）

外部依赖项（必填）

积极维护（必填-复选框）

合规性得分（可选）

测试覆盖率（可选）

测试通过（可选）

测试失败（可选）

Q：如果我不知道一些价值观怎么办？

Q：工具描述应该有多详细？

Q：我需要添加所有工具吗？

Q：如果我的服务器有50多个工具怎么办？

Q：我可以编辑生成的文件吗？