Skip to content

Commit 850ad69

Browse files
zhensherlockzhensherlock
committed
docs: add chinese documentation for mcp kit
1 parent ef00d5c commit 850ad69

File tree

6 files changed

+302
-4
lines changed

6 files changed

+302
-4
lines changed

‎docs/.vitepress/config.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ export default defineConfig({
1212
['link', { rel: 'shortcut icon', href: '/mcp-kit/favicons/favicon.png' }],
1313
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/mcp-kit/favicons/apple-touch-icon.png' }],
1414
],
15+
locales: {
16+
root: { label: 'English', lang: 'en-US', dir: 'ltr' },
17+
zh: { label: '简体中文', lang: 'zh-Hans', dir: 'ltr' },
18+
},
1519
themeConfig: {
1620
// https://vitepress.dev/reference/default-theme-config
1721
logo: '/logo.png',
@@ -22,14 +26,14 @@ export default defineConfig({
2226
{ text: 'Home', link: '/' },
2327
{ text: 'Guide', link: '/guide/what-is-mcp', activeMatch: '/guide/' },
2428
{
25-
text: '0.0.7',
29+
text: '0.0.8',
2630
items: [
2731
{
2832
text: 'Changelog',
2933
link: 'https://github.com/my-mcp-hub/mcp-kit/blob/main/packages/create-mcp-kit/CHANGELOG.md'
3034
},
31-
]
32-
}
35+
],
36+
},
3337
],
3438

3539
sidebar: [
@@ -42,5 +46,5 @@ export default defineConfig({
4246
],
4347
},
4448
],
45-
}
49+
},
4650
})

‎docs/zh/config.ts‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import { defineAdditionalConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineAdditionalConfig({
5+
description: '一个轻松创建 MCP 应用的 CLI 工具',
6+
themeConfig: {
7+
nav: [
8+
{ text: '首页', link: '/zh/' },
9+
{ text: '指南', link: '/zh/guide/what-is-mcp', activeMatch: '/guide/' },
10+
{
11+
text: '0.0.8',
12+
items: [
13+
{
14+
text: 'Changelog',
15+
link: 'https://github.com/my-mcp-hub/mcp-kit/blob/main/packages/create-mcp-kit/CHANGELOG.md'
16+
},
17+
],
18+
},
19+
],
20+
21+
sidebar: [
22+
{
23+
text: '简介',
24+
items: [
25+
{ text: '什么是MCP？', link: '/zh/guide/what-is-mcp' },
26+
{ text: '什么是MCP Kit？', link: '/zh/guide/what-is-mcp-kit' },
27+
{ text: '快速开始', link: '/zh/guide/getting-started' },
28+
],
29+
},
30+
],
31+
},
32+
})

‎docs/zh/guide/getting-started.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
layout: doc
3+
---
4+
5+
# 入门指南
6+
7+
## 安装
8+
9+
### 前提条件
10+
11+
- [Node.js](https://nodejs.org/) 版本 18 或更高。
12+
- 通过命令行界面（CLI）访问 MCP Kit 的终端。
13+
14+
MCP Kit 可用于创建新的 MCP（模型上下文协议）应用程序。您可以使用以下任何包管理器安装和使用它：
15+
16+
::: code-group
17+
```sh [npm]
18+
$ npm create mcp-kit@latest
19+
```
20+
21+
```sh [pnpm]
22+
$ pnpm create mcp-kit@latest
23+
```
24+
25+
```sh [yarn]
26+
$ yarn create mcp-kit@latest
27+
```
28+
:::
29+
30+
::: tip NOTE
31+
MCP Kit 是一个仅支持 ESM 的包。它需要 Node.js 版本 18 或更高，并使用现代 JavaScript 特性。
32+
:::
33+
34+
## 设置向导
35+
36+
当您运行创建命令时，MCP Kit 将启动一个交互式设置向导，引导您创建一个新项目：
37+
38+
<<< @/snippets/init.ansi
39+
40+
1. 首先，系统会提示您选择 **Project type**:
41+
- **MCP Server**: 创建一个为 MCP 客户端提供工具、资源和提示的服务器
42+
- **MCP Client**: 创建一个连接到 MCP 服务器的客户端
43+
44+
2. 接下来，系统会要求您提供**Project name** (默认为 `mcp-[type]-starter`)
45+
46+
3. 选择您偏好的 **Project language**:
47+
- **TypeScript** (recommended)
48+
- **JavaScript**
49+
50+
4. 选择 **Project Transport Type** （可以选择多个选项）:
51+
- **STDIO**: 通过标准输入/输出流进行通信
52+
- **Streamable HTTP**: 具有流式功能的 RESTful API
53+
- **SSE**: 用于实时通信的服务器发送事件
54+
55+
5. 选择 **Project template**:
56+
- **Standard**: 包含推荐的插件和配置
57+
- **Custom**: 允许您选择特定的插件
58+
59+
6. 如果您选择了 **Custom** 模板, 系统会提示您选择 **Project plugins**:
60+
- **GitHub Action**: CI/CD 工作流
61+
- **Vitest**: 测试框架
62+
- **Inspector**: 调试工具（仅限服务器项目）
63+
- **ESLint + Prettier + Lint-staged**: 代码质量工具
64+
- **Commitlint**: 提交消息检查
65+
- **Changelog**: 自动生成变更日志
66+
67+
7. 最后，系统会询问您是否要自动 **install dependencies**
68+
69+
完成这些步骤后，MCP Kit 将使用所选配置创建您的项目。
70+
71+
## 文件结构
72+
73+
生成的文件结构取决于您选择的项目类型。
74+
75+
### MCP 服务器项目结构
76+
77+
```
78+
├── src/
79+
│ ├── tools/ # MCP 工具实现
80+
│ │ ├── index.ts # 工具注册
81+
│ │ └── register*.ts # 单个工具实现
82+
│ ├── resources/ # MCP 资源实现
83+
│ │ └── index.ts # 资源注册
84+
│ ├── prompts/ # MCP 提示实现
85+
│ │ └── index.ts # 提示注册
86+
│ ├── services/ # 服务器实现
87+
│ │ ├── stdio.ts # STDIO 传输实现
88+
│ │ └── web.ts # 可流式 HTTP 和 SSE 传输实现
89+
│ └── index.ts # 入口点
90+
├── tests/ # 测试文件（可选）
91+
├── scripts/ # 构建和开发脚本
92+
├── .github/ # GitHub Actions 工作流（可选）
93+
├── .husky/ # Git 钩子（可选）
94+
└── package.json
95+
```
96+
97+
### MCP 客户端项目结构
98+
99+
```
100+
├── src/
101+
│ └── index.ts # 带有传输实现的入口点
102+
├── tests/ # 测试文件（可选）
103+
├── scripts/ # 构建和开发脚本
104+
├── .github/ # GitHub Actions 工作流（可选）
105+
├── .husky/ # Git 钩子（可选）
106+
└── package.json
107+
```
108+
109+
::: tip
110+
项目结构设计为模块化和可扩展的。您可以根据自己的需求进行自定义。
111+
:::
112+
113+
## 启动和运行
114+
115+
创建项目后，您可以使用以下 npm 脚本来开发、测试和构建您的应用程序：
116+
117+
### MCP 服务器开发脚本
118+
119+
```json [package.json]
120+
{
121+
"scripts": {
122+
"dev": "以 stdio 模式启动开发服务器",
123+
"dev:web": "以 web 模式启动开发服务器",
124+
"build": "构建项目",
125+
"test": "运行测试（如果选择了 vitest 插件）",
126+
"coverage": "生成测试覆盖率报告（如果选择了 vitest 插件）",
127+
"lint": "运行代码检查（如果选择了 style 插件）"
128+
}
129+
}
130+
```
131+
132+
要启动开发服务器，请运行：
133+
134+
::: code-group
135+
136+
```sh [npm]
137+
$ npm run dev
138+
```
139+
140+
```sh [pnpm]
141+
$ pnpm run dev
142+
```
143+
144+
```sh [yarn]
145+
$ yarn dev
146+
```
147+
148+
:::
149+
150+
### MCP 客户端开发脚本
151+
152+
客户端项目包含类似的脚本，用于开发、测试和构建：
153+
154+
```json [package.json]
155+
{
156+
"scripts": {
157+
"dev": "以开发模式启动客户端",
158+
"build": "构建项目",
159+
"test": "运行测试（如果选择了 vitest 插件）",
160+
"coverage": "生成测试覆盖率报告（如果选择了 vitest 插件）",
161+
"lint": "运行代码检查（如果选择了 style 插件）"
162+
}
163+
}
164+
```

‎docs/zh/guide/what-is-mcp-kit.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: doc
3+
---
4+
# 什么是 MCP Kit？
5+
6+
MCP Kit 是一个用于创建 MCP（Model Context Protocol）应用程序的工具集，它让开发者能够轻松地构建符合 MCP 标准的服务器和客户端应用。
7+
8+
## MCP Kit 提供什么？
9+
10+
MCP Kit 提供了一套完整的工具和框架，帮助开发者快速搭建 MCP 应用：
11+
12+
- **快速项目脚手架**: 通过简单的命令行工具创建项目结构
13+
- **TypeScript 支持**: 开箱即用的 TypeScript 配置
14+
- **内置开发工具**: 包含测试、构建和代码质量工具
15+
- **可配置的项目模板**: 适应不同开发需求
16+
- **多种传输模式**: 支持 stdio、streamable-http 和 SSE 等通信方式
17+
- **全面的 API**: 丰富的接口支持各种功能实现
18+
19+
## MCP Kit 的核心功能
20+
21+
MCP Kit 支持创建两种类型的项目：
22+
23+
### MCP 服务器
24+
25+
创建 MCP 服务器，为 MCP 客户端提供工具、资源和提示。服务器可以：
26+
27+
- 实现自定义工具供客户端调用
28+
- 定义可被客户端访问的资源
29+
- 创建可重用的提示模板
30+
- 支持多种传输模式（stdio、HTTP、SSE）
31+
32+
### MCP 客户端
33+
34+
创建连接到 MCP 服务器的客户端应用，使用服务器提供的工具、资源和提示。客户端可以：
35+
36+
- 通过多种传输模式连接到服务器
37+
- 调用服务器提供的工具
38+
- 访问服务器定义的资源
39+
- 使用服务器创建的提示模板
40+
41+
## 为什么选择 MCP Kit？
42+
43+
MCP Kit 让开发者能够专注于业务逻辑而不是底层实现细节。通过标准化的接口和工具，它简化了 MCP 应用的开发流程，使得创建高质量的 AI 应用变得更加容易和高效。
44+
45+
无论你是想创建一个提供特定功能的 MCP 服务器，还是需要一个能够利用这些功能的客户端应用，MCP Kit 都能提供所需的工具和框架，帮助你快速实现目标。
46+

‎docs/zh/guide/what-is-mcp.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: doc
3+
---
4+
# 什么是 MCP？
5+
6+
模型上下文协议（Model Context Protocol，MCP）是一个开放协议，它标准化了应用程序如何向大型语言模型（LLMs）提供上下文。可以将 MCP 想象成 AI 应用程序的 USB-C 接口。就像 USB-C 为连接设备与各种外设和配件提供了标准化方式一样，MCP 为连接 AI 模型与不同数据源和工具提供了标准化方式。MCP 使您能够在 LLMs 之上构建代理和复杂工作流，并将您的模型与世界连接起来。
7+
8+
MCP 提供：
9+
- **不断增长的预构建集成列表**，您的 LLM 可以直接插入使用
10+
- **构建 AI 应用程序自定义集成的标准化方式**
11+
- **一个人人都可以自由实现和使用的开放协议**
12+
- **在不同应用程序之间切换的灵活性**，并且可以随身携带您的上下文
13+
14+
如果想了解更多，请访问 MCP 官网：[https://modelcontextprotocol.io/](https://modelcontextprotocol.io/)

‎docs/zh/index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: home
3+
4+
hero:
5+
name: "MCP Kit"
6+
text: "模型上下文协议工具包"
7+
tagline: 一个轻松创建 MCP 应用的 CLI 工具
8+
image:
9+
src: /logo.png
10+
alt: MCP Kit
11+
actions:
12+
- theme: brand
13+
text: 开始使用 👆
14+
link: /guide/what-is-mcp
15+
- theme: alt
16+
text: 查看 GitHub
17+
link: https://github.com/my-mcp-hub/mcp-kit
18+
19+
features:
20+
- title: 快速脚手架
21+
icon: 🚀
22+
details: 快速生成 MCP 服务端和客户端项目，预配置 TypeScript 环境和开发工具。
23+
- title: TypeScript 优先
24+
icon: 📦
25+
details: 内置 TypeScript 支持，具备完整的类型安全、现代 ES 模块和优秀的开发体验。
26+
- title: 开发工具集
27+
icon: 🛠️️
28+
details: 内置测试、代码检查、热重载和构建工具，简化开发流程。
29+
- title: 可配置模板
30+
icon: 🔧️
31+
details: 灵活的项目模板，可根据具体需求自定义。
32+
- title: 多种传输模式
33+
icon: 🌐️
34+
details: 支持 STDIO 和 Web 服务两种模式，部署更灵活。
35+
- title: 完整 API
36+
icon: 📚️
37+
details: 提供易用的 API，用于实现符合 MCP 规范的工具、资源和提示功能。
38+
---

0 commit comments

Comments
 (0)