一个用于为 MCP 服务器生成公开 README 的技能仓库,涵盖能力边界、鉴权、安装方式和危险工具披露。

Stars

5

7 天增长

暂无数据

Fork 数

3

开放 Issue

0

开源协议

MIT

最近更新

2026-07-30

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

它强调诚实披露有副作用的工具和危险级别,并通过可配置选项生成包含安全说明和客户端配置的 README,有助于提升 MCP 服务器文档的透明度和可用性。

适合谁使用

  • 发布 MCP 服务器的开发者
  • 需要更新仓库文档的维护者
  • 需要客户端 mcpServers 配置片段的技术人员
  • 编写 MCP 工具安全说明的文档作者

典型使用场景

  • 为 MCP 服务器草拟或更新英文、中文或双语 README
  • 记录具有副作用的管理或执行工具及其危险级别
  • 生成可直接使用的 mcpServers 客户端配置片段
  • 在 README 中说明认证、环境变量占位符和安全注意事项

项目优势

  • 提供 lang、length、transport、danger 等选项,适配不同项目需求
  • 交付内容包含完整 README 草稿以及工具/安全表格
  • 支持 stdio、sse、http、multi 等多种传输方式
  • 基于 MIT 许可,并可通过 npx skills add 安装

使用前须知

  • 仅面向 MCP 服务器仓库,不适用于通用库
  • 不负责实现服务器本身或提供漏洞利用指导
  • 危险级别由选项手动选择,而非自动评估

README 快速开始

MCP Server README

Public MCP Server README: capability boundaries, auth, install, and dangerous-tools disclosure.

中文简介: MCP Server 公开 README(能力边界、鉴权、危险工具声明)。 — 详见 README.zh.md.

What this skill does

  • Drafts an EN-primary README for one MCP server
  • Documents tools with side effects and danger levels
  • Spells out auth, env placeholders, and security notes
  • Gives paste-ready client mcpServers config snippets

Install

npx skills add / --skill mcp-server-readme

Local monorepo: skills/mcp-server-readme/.

Options

OptionValuesDefault
langen · zh · bilingualen
lengthminimal · standard · fullstandard
transportstdio · sse · http · multistdio
dangernone · some · highsome

When to use

UseDon't
Publish/refresh an MCP server repoNon-MCP generic library only
Disclose write/exec tools honestlyHide admin tools “for simplicity”
Client install JSONImplement the server or write exploits

Deliverable

Complete public README draft + tools/security tables.

See SKILL.md.

Example

../../output/samples/mcp-server-readme-example-01.md

License

MIT — see LICENSE.

相关仓库与替代方案

根据分类、Topic 和编程语言匹配的相似项目。

mereyabdenbekuly-ctrl
精选
mereyabdenbekuly-ctrl GitHub avatar

clodex-ide

Clodex is an open-source, local-first agentic IDE that combines persistent AI tasks, code, terminal, browser, Git, models, memory, and governed execution in one Electron workspace, currently in technical preview.

AI 与机器学习AI 智能体
859
0xwilliamortiz
精选
0xwilliamortiz GitHub avatar

openclaude-improved

OpenClaude is an open-source CLI coding agent that runs on any platform and supports a wide range of LLM providers, offering the same tools and workflows as Claude Code.

AI 与机器学习大语言模型
577
MoonshotAI
精选
MoonshotAI GitHub avatar

Kimi-K3

Kimi K3 is an open-weight, 2.8T-parameter native multimodal agentic model with a 1M-token context window, designed for frontier coding, knowledge work, and reasoning tasks.

AI 与机器学习AI 智能体
3,348