Skip to content

Commit 92cfa69

Browse files
zhensherlockzhensherlock
committed
docs: update readme files with additional config files
1 parent 7951075 commit 92cfa69

File tree

3 files changed

+96
-60
lines changed

3 files changed

+96
-60
lines changed

‎README.md‎

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,27 @@ Create an MCP server that provides tools, resources, and prompts for MCP clients
4747
The generated server project will have the following structure:
4848
4949
├── src/
50-
│ ├── tools/ # MCP tools implementation
51-
│ │ ├── index.ts # Tools registration
52-
│ │ └── register*.ts # Individual tool implementations
53-
│ ├── resources/ # MCP resources implementation
54-
│ │ └── index.ts # Resources registration
55-
│ ├── prompts/ # MCP prompts implementation
56-
│ │ └── index.ts # Prompts registration
57-
│ ├── services/ # Server implementations
58-
│ │ ├── stdio.ts # STDIO transport implementation
59-
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60-
│ └── index.ts # Entry point
61-
├── tests/ # Test files (optional)
62-
├── scripts/ # Build and development scripts
63-
├── .github/ # GitHub Actions workflows (optional)
64-
├── .husky/ # Git hooks (optional)
50+
│ ├── tools/ # MCP tools implementation
51+
│ │ ├── index.ts # Tools registration
52+
│ │ └── register*.ts # Individual tool implementations
53+
│ ├── resources/ # MCP resources implementation
54+
│ │ └── index.ts # Resources registration
55+
│ ├── prompts/ # MCP prompts implementation
56+
│ │ └── index.ts # Prompts registration
57+
│ ├── services/ # Server implementations
58+
│ │ ├── stdio.ts # STDIO transport implementation
59+
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60+
│ └── index.ts # Entry point
61+
├── tests/ # Test files (optional)
62+
├── scripts/ # Build and development scripts
63+
├── .github/ # GitHub Actions workflows (optional)
64+
├── .husky/ # Git hooks (optional)
65+
├── .prettierrc # Prettier configuration (optional)
66+
├── changelog-option.js # Conventional changelog config (optional)
67+
├── commitlint.config.js # Commit message lint rules (optional)
68+
├── eslint.config.js # ESLint configuration (optional)
69+
├── lint-staged.config.js # Lint-staged configuration (optional)
70+
├── vitest.*.ts # Vitest configuration (optional)
6571
└── package.json
6672
```
6773

@@ -84,11 +90,17 @@ Create an MCP client that connects to MCP servers and uses their tools, resource
8490
The generated client project will have the following structure:
8591
8692
├── src/
87-
│ └── index.ts # Entry point with transport implementations
88-
├── tests/ # Test files (optional)
89-
├── scripts/ # Build and development scripts
90-
├── .github/ # GitHub Actions workflows (optional)
91-
├── .husky/ # Git hooks (optional)
93+
│ └── index.ts # Entry point with transport implementations
94+
├── tests/ # Test files (optional)
95+
├── scripts/ # Build and development scripts
96+
├── .github/ # GitHub Actions workflows (optional)
97+
├── .husky/ # Git hooks (optional)
98+
├── .prettierrc # Prettier configuration (optional)
99+
├── changelog-option.js # Conventional changelog config (optional)
100+
├── commitlint.config.js # Commit message lint rules (optional)
101+
├── eslint.config.js # ESLint configuration (optional)
102+
├── lint-staged.config.js # Lint-staged configuration (optional)
103+
├── vitest.*.ts # Vitest configuration (optional)
92104
└── package.json
93105
```
94106

‎packages/create-mcp-kit/README.md‎

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,27 @@ Create an MCP server that provides tools, resources, and prompts for MCP clients
4747
The generated server project will have the following structure:
4848
4949
├── src/
50-
│ ├── tools/ # MCP tools implementation
51-
│ │ ├── index.ts # Tools registration
52-
│ │ └── register*.ts # Individual tool implementations
53-
│ ├── resources/ # MCP resources implementation
54-
│ │ └── index.ts # Resources registration
55-
│ ├── prompts/ # MCP prompts implementation
56-
│ │ └── index.ts # Prompts registration
57-
│ ├── services/ # Server implementations
58-
│ │ ├── stdio.ts # STDIO transport implementation
59-
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60-
│ └── index.ts # Entry point
61-
├── tests/ # Test files (optional)
62-
├── scripts/ # Build and development scripts
63-
├── .github/ # GitHub Actions workflows (optional)
64-
├── .husky/ # Git hooks (optional)
50+
│ ├── tools/ # MCP tools implementation
51+
│ │ ├── index.ts # Tools registration
52+
│ │ └── register*.ts # Individual tool implementations
53+
│ ├── resources/ # MCP resources implementation
54+
│ │ └── index.ts # Resources registration
55+
│ ├── prompts/ # MCP prompts implementation
56+
│ │ └── index.ts # Prompts registration
57+
│ ├── services/ # Server implementations
58+
│ │ ├── stdio.ts # STDIO transport implementation
59+
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60+
│ └── index.ts # Entry point
61+
├── tests/ # Test files (optional)
62+
├── scripts/ # Build and development scripts
63+
├── .github/ # GitHub Actions workflows (optional)
64+
├── .husky/ # Git hooks (optional)
65+
├── .prettierrc # Prettier configuration (optional)
66+
├── changelog-option.js # Conventional changelog config (optional)
67+
├── commitlint.config.js # Commit message lint rules (optional)
68+
├── eslint.config.js # ESLint configuration (optional)
69+
├── lint-staged.config.js # Lint-staged configuration (optional)
70+
├── vitest.*.ts # Vitest configuration (optional)
6571
└── package.json
6672
```
6773

@@ -84,11 +90,17 @@ Create an MCP client that connects to MCP servers and uses their tools, resource
8490
The generated client project will have the following structure:
8591
8692
├── src/
87-
│ └── index.ts # Entry point with transport implementations
88-
├── tests/ # Test files (optional)
89-
├── scripts/ # Build and development scripts
90-
├── .github/ # GitHub Actions workflows (optional)
91-
├── .husky/ # Git hooks (optional)
93+
│ └── index.ts # Entry point with transport implementations
94+
├── tests/ # Test files (optional)
95+
├── scripts/ # Build and development scripts
96+
├── .github/ # GitHub Actions workflows (optional)
97+
├── .husky/ # Git hooks (optional)
98+
├── .prettierrc # Prettier configuration (optional)
99+
├── changelog-option.js # Conventional changelog config (optional)
100+
├── commitlint.config.js # Commit message lint rules (optional)
101+
├── eslint.config.js # ESLint configuration (optional)
102+
├── lint-staged.config.js # Lint-staged configuration (optional)
103+
├── vitest.*.ts # Vitest configuration (optional)
92104
└── package.json
93105
```
94106

‎packages/shared/README.md‎

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,27 @@ Create an MCP server that provides tools, resources, and prompts for MCP clients
4747
The generated server project will have the following structure:
4848
4949
├── src/
50-
│ ├── tools/ # MCP tools implementation
51-
│ │ ├── index.ts # Tools registration
52-
│ │ └── register*.ts # Individual tool implementations
53-
│ ├── resources/ # MCP resources implementation
54-
│ │ └── index.ts # Resources registration
55-
│ ├── prompts/ # MCP prompts implementation
56-
│ │ └── index.ts # Prompts registration
57-
│ ├── services/ # Server implementations
58-
│ │ ├── stdio.ts # STDIO transport implementation
59-
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60-
│ └── index.ts # Entry point
61-
├── tests/ # Test files (optional)
62-
├── scripts/ # Build and development scripts
63-
├── .github/ # GitHub Actions workflows (optional)
64-
├── .husky/ # Git hooks (optional)
50+
│ ├── tools/ # MCP tools implementation
51+
│ │ ├── index.ts # Tools registration
52+
│ │ └── register*.ts # Individual tool implementations
53+
│ ├── resources/ # MCP resources implementation
54+
│ │ └── index.ts # Resources registration
55+
│ ├── prompts/ # MCP prompts implementation
56+
│ │ └── index.ts # Prompts registration
57+
│ ├── services/ # Server implementations
58+
│ │ ├── stdio.ts # STDIO transport implementation
59+
│ │ └── web.ts # Streamable HTTP and SSE transport implementation
60+
│ └── index.ts # Entry point
61+
├── tests/ # Test files (optional)
62+
├── scripts/ # Build and development scripts
63+
├── .github/ # GitHub Actions workflows (optional)
64+
├── .husky/ # Git hooks (optional)
65+
├── .prettierrc # Prettier configuration (optional)
66+
├── changelog-option.js # Conventional changelog config (optional)
67+
├── commitlint.config.js # Commit message lint rules (optional)
68+
├── eslint.config.js # ESLint configuration (optional)
69+
├── lint-staged.config.js # Lint-staged configuration (optional)
70+
├── vitest.*.ts # Vitest configuration (optional)
6571
└── package.json
6672
```
6773

@@ -84,11 +90,17 @@ Create an MCP client that connects to MCP servers and uses their tools, resource
8490
The generated client project will have the following structure:
8591
8692
├── src/
87-
│ └── index.ts # Entry point with transport implementations
88-
├── tests/ # Test files (optional)
89-
├── scripts/ # Build and development scripts
90-
├── .github/ # GitHub Actions workflows (optional)
91-
├── .husky/ # Git hooks (optional)
93+
│ └── index.ts # Entry point with transport implementations
94+
├── tests/ # Test files (optional)
95+
├── scripts/ # Build and development scripts
96+
├── .github/ # GitHub Actions workflows (optional)
97+
├── .husky/ # Git hooks (optional)
98+
├── .prettierrc # Prettier configuration (optional)
99+
├── changelog-option.js # Conventional changelog config (optional)
100+
├── commitlint.config.js # Commit message lint rules (optional)
101+
├── eslint.config.js # ESLint configuration (optional)
102+
├── lint-staged.config.js # Lint-staged configuration (optional)
103+
├── vitest.*.ts # Vitest configuration (optional)
92104
└── package.json
93105
```
94106

0 commit comments

Comments
 (0)