Files

79 lines
4.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 贡献指南
感谢你为 `Awesome-MCP-ZH` 添砖加瓦!🎉
本列表面向中文用户,收录**真实、可用、有价值**的 MCP(模型上下文协议)资源。为了保证质量,提交前请先阅读以下标准,并尽量自查。维护者会按同样的标准评审。
---
## 一、如何提交
1. Fork 本仓库,在 `README.md` 对应分类下新增一行。
2. 保持表格格式一致(见下方「格式规范」),按字母/拼音顺序就近插入。
3. 提交 PR,标题简洁说明新增内容,例如:`新增 XXX 到 🔍 搜索`。
4. **优先提交 PR**;仅开 issue 申请收录可能处理较慢,且仍需符合下列标准。
> 一个 PR 尽量只做一件事(新增/修改一个条目或一个分类),方便评审与合并。
---
## 二、收录标准(评审会逐条核对)
### ✅ 我们欢迎
- **真实可验证的 MCP Server / Client / 资源**:有公开仓库或可访问的官方文档,能看到实际的 MCP 实现(依赖 MCP SDK、定义了工具/资源、有服务器入口)。
- **可安装 / 可调用**:提供 npm / PyPI 包、可执行命令,或稳定可访问的远程端点(HTTPS / SSE / Streamable HTTP)。
- **文档清晰**:README 说明了它能做什么、有哪些工具、如何接入客户端,而不只是营销文案。
- **对中文用户有价值**:通用工具、中文场景工具(国内平台、中文数据源等)尤其受欢迎。
### ❌ 通常不予收录
- **并非真实的 MCP Server**:核心为私有/闭源二进制且仓库内无可验证实现、空仓库、仅有落地页或文档而无服务端源码。
- **付费墙套壳**:仅在免费公共 API 之上包一层按次付费(如 x402 微支付)而无实质增量价值。
- **竞品目录 / 聚合导航站**:与本列表定位重叠的 MCP 聚合目录、导航站、状态/新闻站等(属自我推广)。
- **纯推广 / 营销**:关键词堆砌、夸大宣传、信息前后不一(如工具数量在 README、package.json、描述中互相矛盾)。
- **不稳定 / 难验证**:服务端点为裸 IP、临时部署地址,或缺少 license、过于新近且无任何使用沉淀,导致可用性难以评估。
- **重复条目**:项目已在列表中,或同一 PR/多个 PR 重复提交同一项目。
- **与主题无关**:与 MCP 关联薄弱的项目。
> 注:Star 数不是硬性门槛,但**真实性、文档质量、可安装性、与中文受众的契合度**是关键考量。早期 / 小众但扎实的项目同样欢迎;待项目更成熟、可验证后欢迎再次提交。
---
## 三、格式规范
绝大多数分类使用三列表格:
```markdown
| 名称 | 中文介绍 | 备注 |
| :--- | :--- | :--- |
| [项目名](链接) | 一句话中文介绍:它能做什么、覆盖哪些能力。 | 实现类型, 开发语言, 运行方式, 一句话特点。 |
```
- **名称**:`[显示名](仓库或官方文档链接)`。
- **中文介绍**:简洁的中文说明,突出实际能力,避免营销话术。
- **备注**:用统一的标签描述,常见标签:
| 标签 | 含义 |
| :--- | :--- |
| 官方实现 🎖️ | 由项目方/厂商官方维护 |
| 社区实现 | 第三方/社区维护 |
| 官方参考 | MCP 官方参考实现 |
| Python 开发 🐍 / TypeScript 开发 📇 / JavaScript 开发 📇 / Rust 开发 🦀 / Go 开发 🏎️ | 主要开发语言 |
| 本地运行 🏠 / 云服务 ☁️ / 云端/本地 🏠☁️ | 运行方式 |
| 跨平台 🍎🪟🐧 | 支持的操作系统 |
可在备注末尾补充安装方式(如 `pip install xxx`、`npx -y xxx`)、工具数量、关键特点等。
> 新增一个全新分类前,建议先确认现有分类确实无法容纳;新分类请同时更新 README 顶部的「目录」。
---
## 四、评审与反馈
- 符合标准的 PR 会尽快合并。
- 不符合的会**说明具体原因后关闭**;若项目改进(开源可验证、部署稳定、有使用反馈等)后符合标准,欢迎再次提交。
- 有疑问可在 PR / issue 中讨论,或加江树微信(1796060717)交流。
再次感谢你的贡献!🙏