Skip to content

Commit 28d9e8d

Browse files
committed
docs(mcp): add step-by-step gitmcp connection guide
1 parent cfce008 commit 28d9e8d

9 files changed

Lines changed: 405 additions & 0 deletions

README.es.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ Paquete obligatorio por feature:
202202
- MCP Onboarding alojado: [Modelo](./docs/es/44-modelo-onboarding-mcp-alojado.md)
203203
- MCP Ejemplos por cliente: [Guía visual](./docs/es/45-ejemplos-visuales-clientes-mcp-facil.md)
204204
- MCP Opciones externas gratis: [Guía](./docs/es/47-opciones-gratis-mcp-externo.md)
205+
- MCP Conexión GitMCP: [Paso a paso](./docs/es/48-como-conectar-este-repo-con-gitmcp.md)
205206
- Setup MCP: [Guía del servidor](./docs/es/33-guia-servidor-mcp.md)
206207
- Resultado por comando: [Referencia](./docs/es/40-referencia-resultados-comandos.md)
207208
- Setup clientes: [Recetas](./docs/es/36-recetas-setup-clientes.md)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ Mandatory spec bundle (for each feature):
202202
- MCP Hosted Onboarding: [Model](./docs/en/44-hosted-mcp-onboarding-model.md)
203203
- MCP Client Examples: [Visual Guide](./docs/en/45-client-visual-examples-for-easy-mcp.md)
204204
- MCP Free External Options: [Guide](./docs/en/47-free-external-mcp-options.md)
205+
- MCP GitMCP Connection: [Step-by-step](./docs/en/48-how-to-connect-this-repo-with-gitmcp.md)
205206
- MCP Setup: [Server Guide](./docs/en/33-mcp-server-guide.md)
206207
- MCP Results: [Command Reference](./docs/en/40-command-results-reference.md)
207208
- Client Setup: [Recipes](./docs/en/36-client-setup-recipes.md)

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ flowchart LR
4949
- Hosted MCP onboarding model: [EN](./en/44-hosted-mcp-onboarding-model.md) | [ES](./es/44-modelo-onboarding-mcp-alojado.md)
5050
- Client visual examples: [EN](./en/45-client-visual-examples-for-easy-mcp.md) | [ES](./es/45-ejemplos-visuales-clientes-mcp-facil.md)
5151
- Free external MCP options: [EN](./en/47-free-external-mcp-options.md) | [ES](./es/47-opciones-gratis-mcp-externo.md)
52+
- GitMCP connection guide: [EN](./en/48-how-to-connect-this-repo-with-gitmcp.md) | [ES](./es/48-como-conectar-este-repo-con-gitmcp.md)
5253
- MCP complete reference: [EN](./en/41-complete-mcp-reference.md) | [ES](./es/41-referencia-completa-mcp.md)
5354
- MCP server guide: [EN](./en/33-mcp-server-guide.md) | [ES](./es/33-guia-servidor-mcp.md)
5455
- Launch kit: [EN](./en/34-launch-kit.md) | [ES](./es/34-kit-lanzamiento.md)

docs/en/43-easy-mcp-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Use it when:
1313
Keep [41-complete-mcp-reference.md](./41-complete-mcp-reference.md) for the full technical reference.
1414
Keep [42-project-organization-map.md](./42-project-organization-map.md) for the full folder-by-folder map.
1515
Keep [47-free-external-mcp-options.md](./47-free-external-mcp-options.md) for the dedicated free external MCP comparison.
16+
Keep [48-how-to-connect-this-repo-with-gitmcp.md](./48-how-to-connect-this-repo-with-gitmcp.md) for the exact GitMCP step-by-step connection path.
1617

1718
## The simple idea
1819

docs/en/47-free-external-mcp-options.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,7 @@ What it still should not replace:
8787
If you only need the AI to understand this public repository better, a free external MCP like GitMCP is enough.
8888
If you need the AI to guide the real SDD workflow and work with project files, you still need the framework's own MCP behavior.
8989
```
90+
91+
## Next guide
92+
93+
If you want the exact step-by-step connection flow for this repository, continue with [How to Connect This Repository with GitMCP](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/en/48-how-to-connect-this-repo-with-gitmcp.md).
Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
# How to Connect This Repository with GitMCP
2+
3+
## Purpose
4+
5+
This guide explains, in very simple terms, how to use `GitMCP` with this repository.
6+
7+
Use this guide when:
8+
- you want a free external MCP option
9+
- you want the AI to understand this public repository better
10+
- you do not want to start with local MCP installation
11+
- you want a copy/paste path that is easy to explain to another person
12+
13+
## The simple idea
14+
15+
Think about it like this:
16+
17+
- GitHub is the bookshelf
18+
- GitMCP is the reader that helps the AI open the bookshelf
19+
- `sdd-mcp` is the working assistant that helps run the real SDD workflow
20+
21+
So:
22+
- use `GitHub` to share the repository with people
23+
- use `GitMCP` so an AI can read the public repository as MCP context
24+
- use `sdd-mcp` when you need the real guided workflow of the framework
25+
26+
## The two URLs you need
27+
28+
Main repository:
29+
- `https://github.com/juanklagos/spec-driven-development-template`
30+
31+
GitMCP version of the same repository:
32+
- `https://gitmcp.io/juanklagos/spec-driven-development-template`
33+
34+
## What happens when you use GitMCP
35+
36+
```mermaid
37+
flowchart LR
38+
A["Public GitHub repository"] --> B["GitMCP URL"]
39+
B --> C["AI reads repository context"]
40+
C --> D["AI understands guides, folders, and prompts"]
41+
D --> E["User gets better guidance"]
42+
E --> F["Real SDD actions still belong to sdd-mcp or the local workflow"]
43+
```
44+
45+
## What GitMCP is good for
46+
47+
GitMCP is useful for:
48+
- reading the README
49+
- reading the documentation
50+
- understanding the folder structure
51+
- understanding the SDD framework context
52+
- understanding prompts, guides, and templates
53+
- helping an AI answer questions about this public repository
54+
55+
## What GitMCP is not for
56+
57+
GitMCP is not the operational engine of this framework.
58+
59+
Do not expect it to:
60+
- create local specs in the user's project by itself
61+
- update local `bitacora/` files by itself
62+
- replace the local `sdd-mcp` server
63+
- act as the full execution layer for the user's project
64+
65+
## The shortest explanation possible
66+
67+
If you need one sentence, use this:
68+
69+
```text
70+
GitMCP helps the AI understand this public repository; sdd-mcp helps the AI operate the real SDD workflow.
71+
```
72+
73+
## Step-by-step
74+
75+
### Step 1: confirm the repository URL
76+
77+
For this project, the public repository is:
78+
- `https://github.com/juanklagos/spec-driven-development-template`
79+
80+
### Step 2: derive the GitMCP URL
81+
82+
Take the GitHub path:
83+
- `github.com/juanklagos/spec-driven-development-template`
84+
85+
Replace `github.com` with `gitmcp.io`:
86+
- `gitmcp.io/juanklagos/spec-driven-development-template`
87+
88+
Final URL:
89+
- `https://gitmcp.io/juanklagos/spec-driven-development-template`
90+
91+
### Step 3: add that URL to a client that supports remote MCP
92+
93+
If your AI client supports remote MCP servers by URL, use:
94+
95+
```text
96+
https://gitmcp.io/juanklagos/spec-driven-development-template
97+
```
98+
99+
Simple mental model:
100+
- if the client accepts an MCP URL, paste the GitMCP URL
101+
- if the client only supports local MCP, GitMCP may not be the right first option there
102+
103+
### Step 4: tell the AI what the connection is for
104+
105+
Use a short instruction like this:
106+
107+
```text
108+
Use GitMCP for this repository so you can understand the framework documentation, folder structure, prompts, and onboarding guides.
109+
If we need real SDD actions for a project, use the framework workflow correctly and explain what happens step by step.
110+
```
111+
112+
### Step 5: check that the AI is using it correctly
113+
114+
A good result looks like this:
115+
- the AI explains the framework better
116+
- the AI names the right guides
117+
- the AI understands the folder structure
118+
- the AI does not confuse GitMCP with `sdd-mcp`
119+
120+
A bad result looks like this:
121+
- the AI says GitMCP will create local files in your project automatically
122+
- the AI says GitMCP replaces the full framework workflow
123+
- the AI ignores the difference between public repo context and real project execution
124+
125+
## Copy/paste prompts
126+
127+
### Prompt for a non-technical user
128+
129+
```text
130+
Use the GitMCP connection for https://github.com/juanklagos/spec-driven-development-template so you can understand this framework better.
131+
Guide me in simple language.
132+
Explain what each step does and what I should expect next.
133+
If we need real SDD actions in a project, use the correct workflow and tell me before changing files.
134+
```
135+
136+
### Prompt for an operator or technical user
137+
138+
```text
139+
Use GitMCP for repository context.
140+
Read the easy MCP guide, the project organization map, and the onboarding model first.
141+
Do not confuse GitMCP with the framework's operational sdd-mcp layer.
142+
Be explicit about which part is repository context and which part is real workflow execution.
143+
```
144+
145+
## Easy decision rule
146+
147+
Use this rule:
148+
149+
- need the AI to understand the public repository: use `GitMCP`
150+
- need the AI to help with the real SDD workflow in a project: use `sdd-mcp` or the local framework workflow
151+
- need both: use `GitMCP` for context and `sdd-mcp` for operations
152+
153+
```mermaid
154+
flowchart TD
155+
A["Do you want the AI to understand the public repository?"] -->|Yes| B["Use GitMCP"]
156+
A -->|No| C["Do you need real SDD actions in a project?"]
157+
C -->|Yes| D["Use sdd-mcp or the local workflow"]
158+
C -->|No| E["Use the documentation only"]
159+
```
160+
161+
## What the user should expect
162+
163+
If GitMCP is being used correctly, the user should expect:
164+
- clearer explanations
165+
- better onboarding guidance
166+
- better understanding of the framework structure
167+
- better references to the right docs
168+
169+
The user should not expect:
170+
- automatic project execution just because GitMCP was connected
171+
- automatic creation of local specs just because the repository is public
172+
- the full local workflow to happen without the operational layer
173+
174+
## Recommended combination for this repository
175+
176+
Best combination:
177+
178+
1. `GitMCP`
179+
Purpose:
180+
- help the AI understand this public framework repository
181+
182+
2. local `sdd-mcp`
183+
Purpose:
184+
- run the actual guided SDD workflow
185+
- work with the real files of the target project
186+
187+
3. project documentation
188+
Purpose:
189+
- keep humans and AI aligned on what happens next
190+
191+
## Related guides
192+
193+
- [Easy MCP Guide](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/en/43-easy-mcp-guide.md)
194+
- [Hosted MCP Onboarding Model](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/en/44-hosted-mcp-onboarding-model.md)
195+
- [Free External MCP Options](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/en/47-free-external-mcp-options.md)
196+
- [Project Organization Map](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/en/42-project-organization-map.md)

docs/es/43-guia-mcp-facil.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Esta guía explica cómo usar `sdd-mcp` de la forma más fácil posible.
1313
Mantén [41-referencia-completa-mcp.md](./41-referencia-completa-mcp.md) como referencia técnica completa.
1414
Mantén [42-mapa-organizacion-proyecto.md](./42-mapa-organizacion-proyecto.md) como mapa completo carpeta por carpeta.
1515
Mantén [47-opciones-gratis-mcp-externo.md](./47-opciones-gratis-mcp-externo.md) como comparación dedicada de MCP externo gratuito.
16+
Mantén [48-como-conectar-este-repo-con-gitmcp.md](./48-como-conectar-este-repo-con-gitmcp.md) como la guía exacta paso a paso para conectar GitMCP.
1617

1718
## La idea simple
1819

docs/es/47-opciones-gratis-mcp-externo.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,7 @@ Qué no debería reemplazar:
8787
Si solo necesitas que la IA entienda mejor este repositorio público, un MCP externo gratis como GitMCP es suficiente.
8888
Si necesitas que la IA guíe el flujo real de SDD y trabaje con archivos del proyecto, todavía necesitas el comportamiento propio del MCP del framework.
8989
```
90+
91+
## Siguiente guía
92+
93+
Si quieres el flujo exacto paso a paso para conectar este repositorio, sigue con [Cómo conectar este repositorio con GitMCP](/Users/juanklagos/www/cucutadev/spec-driven-development-template/docs/es/48-como-conectar-este-repo-con-gitmcp.md).

0 commit comments

Comments
 (0)