redcrab2819-ack84/mcp-server-readme

38 stars 0 forks 质量 45 趋势 45

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

概览

Public MCP Server README: capability boundaries, auth, install, and dangerous-tools disclosure. MCP Server 公开 README（能力边界、鉴权、危险工具声明）。 — 详见 README.zh.md. - 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 Local monorepo: skills/mcp-server-readme/. Complete public README draft + tools/security tables. ../../output/samples/mcp-server-readme-example-01.md

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

Option	Values	Default
`lang`	`en` · `zh` · `bilingual`	`en`
`length`	`minimal` · `standard` · `full`	`standard`
`transport`	`stdio` · `sse` · `http` · `multi`	`stdio`
`danger`	`none` · `some` · `high`	`some`

When to use

Use	Don’t
Publish/refresh an MCP server repo	Non-MCP generic library only
Disclose write/exec tools honestly	Hide admin tools “for simplicity”
Client install JSON	Implement 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.

View this README on GitHub

安装

npx skills add <github-user>/<repo> --skill mcp-server-readme