Skip to content

Commit 0493813

Browse files
zhensherlockzhensherlock
committed
style: standardize transport type prompt casing
1 parent e681f94 commit 0493813

File tree

5 files changed

+73
-44
lines changed

5 files changed

+73
-44
lines changed

‎.changeset/spicy-bears-lay.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'create-mcp-kit': patch
3+
---
4+
5+
style: standardize transport type prompt casing

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

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ When you run the create command, MCP Kit will launch an interactive setup wizard
4747
- **TypeScript** (recommended)
4848
- **JavaScript**
4949

50-
4. Select **Project Transport Type** (multiple options can be selected):
50+
4. Select **Project transport type** (multiple options can be selected):
5151
- **STDIO**: Communication through standard input/output streams
5252
- **Streamable HTTP**: RESTful API with streaming capabilities
5353
- **SSE**: Server-Sent Events for real-time communication
@@ -76,33 +76,45 @@ The generated file structure depends on the project type you selected.
7676

7777
```
7878
├── src/
79-
│ ├── tools/ # MCP tools implementation
80-
│ │ ├── index.ts # Tools registration
81-
│ │ └── register*.ts # Individual tool implementations
82-
│ ├── resources/ # MCP resources implementation
83-
│ │ └── index.ts # Resources registration
84-
│ ├── prompts/ # MCP prompts implementation
85-
│ │ └── index.ts # Prompts registration
86-
│ ├── services/ # Server implementations
87-
│ │ ├── stdio.ts # STDIO transport implementation
88-
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
89-
│ └── index.ts # Entry point
90-
├── tests/ # Test files (optional)
91-
├── scripts/ # Build and development scripts
92-
├── .github/ # GitHub Actions workflows (optional)
93-
├── .husky/ # Git hooks (optional)
79+
│ ├── tools/ # MCP tools implementation
80+
│ │ ├── index.ts # Tools registration
81+
│ │ └── register*.ts # Individual tool implementations
82+
│ ├── resources/ # MCP resources implementation
83+
│ │ └── index.ts # Resources registration
84+
│ ├── prompts/ # MCP prompts implementation
85+
│ │ └── index.ts # Prompts registration
86+
│ ├── services/ # Server implementations
87+
│ │ ├── stdio.ts # STDIO transport implementation
88+
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
89+
│ └── index.ts # Entry point
90+
├── tests/ # Test files (optional)
91+
├── scripts/ # Build and development scripts
92+
├── .github/ # GitHub Actions workflows (optional)
93+
├── .husky/ # Git hooks (optional)
94+
├── .prettierrc # Prettier configuration (optional)
95+
├── changelog-option.js # Conventional changelog config (optional)
96+
├── commitlint.config.js # Commit message lint rules (optional)
97+
├── eslint.config.js # ESLint configuration (optional)
98+
├── lint-staged.config.js # Lint-staged configuration (optional)
99+
├── vitest.*.ts # Vitest configuration (optional)
94100
└── package.json
95101
```
96102

97103
### MCP Client Project Structure
98104

99105
```
100106
├── src/
101-
│ └── index.ts # Entry point with transport implementations
102-
├── tests/ # Test files (optional)
103-
├── scripts/ # Build and development scripts
104-
├── .github/ # GitHub Actions workflows (optional)
105-
├── .husky/ # Git hooks (optional)
107+
│ └── index.ts # Entry point with transport implementations
108+
├── tests/ # Test files (optional)
109+
├── scripts/ # Build and development scripts
110+
├── .github/ # GitHub Actions workflows (optional)
111+
├── .husky/ # Git hooks (optional)
112+
├── .prettierrc # Prettier configuration (optional)
113+
├── changelog-option.js # Conventional changelog config (optional)
114+
├── commitlint.config.js # Commit message lint rules (optional)
115+
├── eslint.config.js # ESLint configuration (optional)
116+
├── lint-staged.config.js # Lint-staged configuration (optional)
117+
├── vitest.*.ts # Vitest configuration (optional)
106118
└── package.json
107119
```
108120

‎docs/snippets/init.ansi‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
◇ Project language:
1010
│ TypeScript
1111
│
12-
◇ Project Transport Type:
12+
◇ Project transport type:
1313
│ STDIO
1414
│
1515
◇ Project template:

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

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ MCP Kit 是一个仅支持 ESM 的包。它需要 Node.js 版本 18 或更高，
4747
- **TypeScript** (recommended)
4848
- **JavaScript**
4949

50-
4. 选择 **Project Transport Type** （可以选择多个选项）:
50+
4. 选择 **Project transport type** （可以选择多个选项）:
5151
- **STDIO**: 通过标准输入/输出流进行通信
5252
- **Streamable HTTP**: 具有流式功能的 RESTful API
5353
- **SSE**: 用于实时通信的服务器发送事件
@@ -76,33 +76,45 @@ MCP Kit 是一个仅支持 ESM 的包。它需要 Node.js 版本 18 或更高，
7676

7777
```
7878
├── 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 钩子（可选）
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+
├── .prettierrc # Prettier 配置（可选）
95+
├── changelog-option.js # 约定式变更日志配置（可选）
96+
├── commitlint.config.js # 提交消息检查规则（可选）
97+
├── eslint.config.js # ESLint 配置（可选）
98+
├── lint-staged.config.js # Lint-staged 配置（可选）
99+
├── vitest.*.ts # Vitest 配置（可选）
94100
└── package.json
95101
```
96102

97103
### MCP 客户端项目结构
98104

99105
```
100106
├── src/
101-
│ └── index.ts # 带有传输实现的入口点
102-
├── tests/ # 测试文件（可选）
103-
├── scripts/ # 构建和开发脚本
104-
├── .github/ # GitHub Actions 工作流（可选）
105-
├── .husky/ # Git 钩子（可选）
107+
│ └── index.ts # 带有传输实现的入口点
108+
├── tests/ # 测试文件（可选）
109+
├── scripts/ # 构建和开发脚本
110+
├── .github/ # GitHub Actions 工作流（可选）
111+
├── .husky/ # Git 钩子（可选）
112+
├── .prettierrc # Prettier 配置（可选）
113+
├── changelog-option.js # 约定式变更日志配置（可选）
114+
├── commitlint.config.js # 提交消息检查规则（可选）
115+
├── eslint.config.js # ESLint 配置（可选）
116+
├── lint-staged.config.js # Lint-staged 配置（可选）
117+
├── vitest.*.ts # Vitest 配置（可选）
106118
└── package.json
107119
```
108120

‎packages/create-mcp-kit/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const group = await clack.group(
4545
}),
4646
transports: () => {
4747
return clack.multiselect({
48-
message: 'Project Transport Type:',
48+
message: 'Project transport type:',
4949
required: true,
5050
initialValues: ['stdio'],
5151
options: [

0 commit comments

Comments
 (0)