Skip to content

Commit ef54ef8

Browse files
author
feiyun0112
committed
0.1.0
1 parent 8033afb commit ef54ef8

33 files changed

+2279
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: main
2+
on:
3+
push:
4+
branches:
5+
- main
6+
paths-ignore:
7+
- '**.md'
8+
- '**.linq'
9+
- '**.gif'
10+
workflow_dispatch:
11+
12+
jobs:
13+
deploy-nuget:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- name: Build
18+
working-directory: src/SpecCodingMcpServer
19+
run: dotnet build --configuration Release
20+
- name: Pack
21+
working-directory: src/SpecCodingMcpServer
22+
run: dotnet pack --no-build --configuration Release /p:PackageReleaseNotes="See https://github.com/feiyun0112/spec-coding-mcp/blob/main/CHANGELOG.md for release history."
23+
- name: Push NuGet package
24+
working-directory: src/SpecCodingMcpServer
25+
run: |
26+
dotnet nuget push **/*.nupkg --skip-duplicate --source "nuget.org" --api-key ${{ secrets.NUGET_KEY }} || true

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ bld/
2222
[Oo]bj/
2323
[Ll]og/
2424
[Ll]ogs/
25+
.vs/
2526

2627
# .NET Core
2728
project.lock.json

‎README.md‎

Lines changed: 144 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,144 @@
1-
# spec-coding-mcp
1+
**[简体中文](./README_zh-cn.md)**
2+
3+
# Spec Coding MCP Server
4+
5+
Transform feature ideas into production-ready code through systematic **Spec-Driven Development**
6+
7+
## 🎯 Spec-Driven Development Workflow
8+
9+
### Phase 1: Feature Definition
10+
11+
- Learn details about feature by interacting with user
12+
13+
### Phase 2: Requirements Gathering
14+
15+
- Transform feature idea into formal requirement using EARS format
16+
17+
### Phase 3: Design Documentation
18+
19+
- Develop technical architecture based on approved requirements
20+
21+
### Phase 4: Task Planning
22+
23+
- Break down design into discrete, actionable coding tasks
24+
25+
### Phase 5: Task Execution
26+
27+
- Implement the code following the plan
28+
29+
## 🚀 Quick Start
30+
31+
### Config MCP Server
32+
33+
#### Using code
34+
35+
```json
36+
{
37+
"servers": {
38+
"SpecCodingMcpServer": {
39+
"type": "stdio",
40+
"command": "<PATH TO SpecCodingMcpServer.exe DIRECTORY>",
41+
"args": []
42+
}
43+
}
44+
}
45+
```
46+
47+
#### Using exe
48+
49+
```json
50+
{
51+
"servers": {
52+
"SpecCodingMcpServer": {
53+
"type": "stdio",
54+
"command": "dotnet",
55+
"args": [
56+
"run",
57+
"--project",
58+
"<PATH TO spec-coding-mcp\src\SpecCodingMcpServer DIRECTORY>"
59+
]
60+
}
61+
}
62+
}
63+
```
64+
65+
#### Using NuGet
66+
67+
- Visit `NuGet.org` and filter by mcpserver package type
68+
- Search `SpecCodingMcpServer` and copy the configuration from the “MCP Server” tab
69+
70+
### Start the Workflow
71+
72+
Here's a complete example of using the Spec Coding workflow:
73+
74+
#### 1. Feature Definition
75+
```
76+
Me: Start Spec Coding
77+
78+
AI: [call SpecCodingMcpServer/spec_coding_workflow_start]
79+
Welcome to Spec Coding! Let's start by defining your feature.
80+
81+
Me: create a Vue todo app
82+
83+
AI：Let me clarify a few more details to ensure we build exactly what you need
84+
85+
Me: [enter more details for the feature]
86+
87+
AI：Does this look good to proceed? Please confirm with "yes"
88+
89+
Me: yes
90+
91+
AI：[call SpecCodingMcpServer/spec_coding_feature_confirmed]
92+
[Create the feature documentation directory and README file as required by the spec coding workflow]
93+
```
94+
#### 2. Requirements Gathering
95+
```
96+
AI: Starting the requirements gathering phase for the Vue todo app
97+
[call SpecCodingMcpServer/spec_coding_requirements_start]
98+
[Create the requirements document for the Vue todo app with detailed EARS format requirements]
99+
Do the requirements look good? If so, we can move on to the design phase.
100+
101+
Me: yes
102+
103+
AI: [call SpecCodingMcpServer/spec_coding_requirements_confirmed]
104+
```
105+
106+
#### 3. Design Documentation
107+
```
108+
AI: Starting the design phase for the Vue todo app
109+
[call SpecCodingMcpServer/spec_coding_design_start]
110+
[Create a comprehensive design document for the Vue todo app based on the requirements]
111+
Does the design look good? If so, we can move on to the implementation plan.
112+
113+
Me: yes
114+
115+
AI: [call SpecCodingMcpServer/spec_coding_design_confirmed]
116+
```
117+
118+
#### 4. Task Planning
119+
```
120+
AI: Starting the task creation phase for the Vue todo app implementation
121+
[call SpecCodingMcpServer/spec_coding_tasks_start]
122+
[Create a comprehensive task list for implementing the Vue todo app based on the design and requirements]
123+
Do the tasks look good? Please review the task list and let me know if you'd like any adjustments before we proceed to the implementation phase.
124+
125+
User: yes
126+
127+
AI: [call SpecCodingMcpServer/spec_coding_tasks_confirmed]
128+
```
129+
130+
#### 5. Task Execution
131+
```
132+
AI: Starting the actual implementation phase for the Vue todo app
133+
[call SpecCodingMcpServer/spec_coding_execute_start]
134+
[Execute tasks one by one]
135+
```
136+
137+
#### Generated Folder Structure
138+
```
139+
.spec-coding/features/vue-todo-app/
140+
├── requirements.md # EARS-format requirements
141+
├── README.md # Feature Description
142+
├── design.md # Technical architecture
143+
└── tasks.md # Implementation checklist
144+
```

‎README_zh-cn.md‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Spec Coding MCP 服务器
2+
3+
通过系统化的**规格驱动开发**，将功能想法转化为可投入生产的代码
4+
5+
## 🎯 规格驱动开发工作流程
6+
7+
### 阶段 1：功能定义
8+
9+
- 通过与用户交互了解功能细节
10+
11+
### 阶段 2：需求收集
12+
13+
- 使用 EARS 格式将功能想法转化为正式需求
14+
15+
### 阶段 3：设计文档
16+
17+
- 根据确认的需求设计技术架构
18+
19+
### 阶段 4：任务规划
20+
21+
- 将设计分解为独立的、可执行的编码任务
22+
23+
### 阶段 5：任务执行
24+
25+
- 按照计划实现代码
26+
27+
28+
## 🚀 快速开始
29+
### 配置 MCP 服务器
30+
31+
#### 使用代码方式
32+
33+
`
34+
{
35+
"servers": {
36+
"SpecCodingMcpServer": {
37+
"type": "stdio",
38+
"command": "<SpecCodingMcpServer.exe 目录路径>",
39+
"args": []
40+
}
41+
}
42+
}
43+
`
44+
45+
#### 使用可执行文件方式
46+
`
47+
{
48+
"servers": {
49+
"SpecCodingMcpServer": {
50+
"type": "stdio",
51+
"command": "dotnet",
52+
"args": [
53+
"run",
54+
"--project",
55+
"<spec-coding-mcp\src\SpecCodingMcpServer 目录路径>"
56+
]
57+
}
58+
}
59+
}
60+
`
61+
62+
#### 使用 NuGet 方式
63+
64+
- 访问 `NuGet.org` 并按 mcpserver 包类型筛选
65+
66+
- 搜索 `SpecCodingMcpServer` 并从 “MCP Server” 选项卡复制配置
67+
68+
### 启动工作流程
69+
70+
以下是使用**规格驱动开发**工作流程的完整示例：
71+
72+
#### 1. 功能定义
73+
`
74+
我：开始规格编码
75+
76+
AI：[调用 SpecCodingMcpServer/spec_coding_workflow_start]
77+
欢迎来到规格编码！让我们从定义你的功能开始。
78+
79+
我：创建一个 Vue 待办应用
80+
81+
AI：为了确保我们构建出完全符合你需求的产品，我需要再明确一些细节
82+
83+
我：[输入关于该功能的更多细节]
84+
85+
AI：这样看起来可以继续了吗？请用“是”确认
86+
87+
我：是
88+
89+
AI：[调用 SpecCodingMcpServer/spec_coding_feature_confirmed]
90+
[按照规格编码工作流程的要求创建功能文档目录和 README 文件]
91+
`
92+
93+
#### 2. 需求收集
94+
95+
`
96+
AI：开始 Vue 待办应用的需求收集阶段
97+
[调用 SpecCodingMcpServer/spec_coding_requirements_start]
98+
[创建具有详细 EARS 格式需求的 Vue 待办应用需求文档]
99+
这些需求看起来可以吗？如果可以，我们可以进入设计阶段。
100+
101+
我：是
102+
103+
AI：[调用 SpecCodingMcpServer/spec_coding_requirements_confirmed]
104+
`
105+
106+
#### 3. 设计文档
107+
108+
`
109+
AI：开始 Vue 待办应用的设计阶段
110+
[调用 SpecCodingMcpServer/spec_coding_design_start]
111+
[根据需求创建 Vue 待办应用的全面设计文档]
112+
这个设计看起来可以吗？如果可以，我们可以进入实施计划阶段。
113+
114+
我：是
115+
116+
AI：[调用 SpecCodingMcpServer/spec_coding_design_confirmed]
117+
`
118+
119+
#### 4. 任务规划
120+
121+
`
122+
AI：开始 Vue 待办应用实施的任务创建阶段
123+
[调用 SpecCodingMcpServer/spec_coding_tasks_start]
124+
[根据设计和需求创建实现 Vue 待办应用的全面任务列表]
125+
这些任务看起来可以吗？请查看任务列表，在我们进入实施阶段之前，如果你需要任何调整，请告诉我。
126+
127+
用户：是
128+
129+
AI：[调用 SpecCodingMcpServer/spec_coding_tasks_confirmed]
130+
`
131+
132+
#### 5. 任务执行
133+
134+
`
135+
AI：开始 Vue 待办应用的实际实施阶段
136+
[调用 SpecCodingMcpServer/spec_coding_execute_start]
137+
[逐一执行任务]
138+
`
139+
140+
#### 最终生成的文件夹结构
141+
`
142+
.spec-coding/features/vue-todo-app/
143+
├── requirements.md # EARS 格式的需求
144+
├── README.md # 功能描述
145+
├── design.md # 技术架构
146+
└── tasks.md # 实施清单
147+
`

‎src/SpecCodingMcpServer/.mcp/server.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"$schema": "https://modelcontextprotocol.io/schemas/draft/2025-07-09/server.json",
3+
"description": "An MCP server for Spec Coding.",
4+
"name": "io.github.feiyun0112/spec-coding-mcp",
5+
"packages": [
6+
{
7+
"registry_name": "nuget",
8+
"name": "SpecCodingMcpServer",
9+
"version": "0.1.0",
10+
"package_arguments": [],
11+
"environment_variables": []
12+
}
13+
],
14+
"repository": {
15+
"url": "https://github.com/feiyun0112/spec-coding-mcp",
16+
"source": "github"
17+
},
18+
"version_detail": {
19+
"version": "0.1.0"
20+
}
21+
}

0 commit comments

Comments
 (0)