Skip to content

Commit 2a65b83

Browse files
committed
docs(mcp): clarify external repo-context mcp vs sdd-mcp
1 parent 3a0bd75 commit 2a65b83

6 files changed

Lines changed: 180 additions & 0 deletions

File tree

README.es.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ Si tu cliente de IA soporta MCP, este repositorio ya incluye un servidor local `
4545
Si quieres la explicación más simple primero:
4646
- [Guía fácil de MCP](./docs/es/43-guia-mcp-facil.md)
4747

48+
Diferencia importante:
49+
- `GitMCP` o similar puede ayudar a una IA a leer y entender este repositorio público gratis.
50+
- No reemplaza el comportamiento propio de `sdd-mcp` dentro del framework.
51+
- Usa `GitMCP` para contexto remoto del repo y `sdd-mcp` para el flujo real guiado de SDD.
52+
4853
Ruta rápida:
4954
1. Compila el servidor:
5055

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ If your AI client supports MCP, this repository now includes a local `sdd-mcp` s
4545
If you want the simplest explanation first:
4646
- [Easy MCP Guide](./docs/en/43-easy-mcp-guide.md)
4747

48+
Important distinction:
49+
- `GitMCP` or similar can help an AI read and understand this public repository for free.
50+
- It does not replace this framework's own `sdd-mcp` behavior.
51+
- Use `GitMCP` for remote repo context and `sdd-mcp` for the real guided SDD workflow.
52+
4853
Quick path:
4954
1. Build the server:
5055

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,71 @@ Important:
7474
- others may show them as prompt templates or actions
7575
- if your client does not show them, write the request in plain language instead
7676

77+
## External MCP, explained simply
78+
79+
There are 2 very different things that may look similar:
80+
81+
1. an external repo-context MCP such as `GitMCP`
82+
2. this framework's own operational MCP, `sdd-mcp`
83+
84+
Think of them like this:
85+
- `GitMCP` is like a public librarian for your repository
86+
- `sdd-mcp` is like the project operator that can guide and organize work
87+
88+
### What `GitMCP` is good for
89+
90+
Use `GitMCP` when you want:
91+
- a free and immediate external MCP
92+
- AI to read your public repository
93+
- AI to understand your README, docs, templates, and structure
94+
- easier diffusion and discovery
95+
96+
What the user gets:
97+
- quick remote context
98+
- no server hosting work from your side
99+
- a simple URL form based on the GitHub repository
100+
101+
### What `GitMCP` does not replace
102+
103+
`GitMCP` does not replace your own MCP product layer.
104+
105+
It does not give you:
106+
- your custom tools
107+
- your custom prompts as a controlled product surface
108+
- your own project rules as an owned service
109+
- real local file writes in the user's project
110+
111+
So the right mental model is:
112+
- `GitMCP` = remote reading and understanding
113+
- `sdd-mcp` = guided SDD operations and framework behavior
114+
115+
## The recommended combination
116+
117+
For this framework, the easiest professional setup is:
118+
119+
```mermaid
120+
flowchart LR
121+
A["Public repo on GitHub"] --> B["GitMCP or similar"]
122+
A --> C["Local sdd-mcp"]
123+
B --> D["AI understands the framework"]
124+
C --> E["AI can guide real SDD actions"]
125+
E --> F["Project files and traceability"]
126+
```
127+
128+
This means:
129+
- use `GitMCP` if you want free external understanding of the repo
130+
- use `sdd-mcp` if you want the real framework workflow
131+
- combine both if you want the easiest operator experience
132+
133+
## What to tell a user in plain language
134+
135+
```text
136+
There are two MCP layers.
137+
One layer helps the AI read and understand the public repository.
138+
The other layer helps the AI guide the real SDD workflow.
139+
If you only use a repo-context MCP like GitMCP, the AI can understand the template better, but it does not replace the framework's own MCP behavior.
140+
```
141+
77142
## What the user should expect every time
78143

79144
For beginner-friendly use, the AI should answer in this order:

docs/en/44-hosted-mcp-onboarding-model.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Short term:
9797
- keep `sdd-mcp` local for operations
9898
- publish docs that define the hosted layer contract
9999
- use the current HTTP transport as the conceptual base
100+
- optionally use `GitMCP` as the free external repo-context layer for public understanding
100101

101102
Mid term:
102103
- host a read-oriented onboarding MCP endpoint
@@ -106,6 +107,25 @@ Mid term:
106107
Long term:
107108
- offer a one-click launcher or thin local bridge that the hosted layer can orchestrate through the client
108109

110+
## Where `GitMCP` fits
111+
112+
`GitMCP` is useful as a free external layer for public repositories.
113+
114+
What it can do well:
115+
- let AI clients read and understand this repository remotely
116+
- expose public docs and structure with almost no setup
117+
- help with discovery, demos, and diffusion
118+
119+
What it should not be treated as:
120+
- a replacement for `sdd-mcp`
121+
- a replacement for your custom prompts and product behavior
122+
- a safe writer into the user's local project
123+
124+
So the recommended framing is:
125+
- `GitMCP` or similar = external repo context
126+
- hosted onboarding MCP = your owned remote guidance layer
127+
- local `sdd-mcp` = operational local execution layer
128+
109129
## Minimum hosted contract
110130

111131
The hosted onboarding MCP should provide at least:

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,71 @@ Importante:
7474
- otros pueden mostrarlos como plantillas de prompt o acciones
7575
- si tu cliente no los muestra, escribe la petición en lenguaje natural
7676

77+
## MCP externo, explicado simple
78+
79+
Hay 2 cosas muy distintas que pueden parecer parecidas:
80+
81+
1. un MCP externo de contexto de repositorio como `GitMCP`
82+
2. el MCP operativo de este framework, `sdd-mcp`
83+
84+
Piensa en ellas así:
85+
- `GitMCP` es como un bibliotecario público del repositorio
86+
- `sdd-mcp` es como el operador del proyecto que puede guiar y organizar el trabajo
87+
88+
### Para qué sí sirve `GitMCP`
89+
90+
Usa `GitMCP` cuando quieres:
91+
- un MCP externo gratuito e inmediato
92+
- que la IA lea tu repositorio público
93+
- que la IA entienda el README, docs, templates y estructura
94+
- facilitar difusión y descubrimiento
95+
96+
Qué obtiene el usuario:
97+
- contexto remoto rápido
98+
- cero trabajo de hosting de tu lado
99+
- una URL simple basada en el repositorio GitHub
100+
101+
### Qué no reemplaza `GitMCP`
102+
103+
`GitMCP` no reemplaza la capa de producto MCP propia.
104+
105+
No te da:
106+
- tus tools personalizados
107+
- tus prompts personalizados como superficie de producto controlada
108+
- tus reglas del proyecto como servicio propio
109+
- escrituras reales en archivos locales del proyecto del usuario
110+
111+
Entonces el modelo correcto es:
112+
- `GitMCP` = lectura y entendimiento remoto
113+
- `sdd-mcp` = operaciones guiadas de SDD y comportamiento del framework
114+
115+
## La combinación recomendada
116+
117+
Para este framework, la configuración profesional más fácil es:
118+
119+
```mermaid
120+
flowchart LR
121+
A["Repo público en GitHub"] --> B["GitMCP o similar"]
122+
A --> C["sdd-mcp local"]
123+
B --> D["La IA entiende el framework"]
124+
C --> E["La IA puede guiar acciones SDD reales"]
125+
E --> F["Archivos del proyecto y trazabilidad"]
126+
```
127+
128+
Esto significa:
129+
- usa `GitMCP` si quieres entendimiento externo y gratuito del repo
130+
- usa `sdd-mcp` si quieres el flujo real del framework
131+
- combina ambos si quieres la experiencia más fácil para el operador
132+
133+
## Qué decirle a un usuario en lenguaje simple
134+
135+
```text
136+
Hay dos capas MCP.
137+
Una capa ayuda a la IA a leer y entender el repositorio público.
138+
La otra capa ayuda a la IA a guiar el flujo real de SDD.
139+
Si solo usas un MCP de contexto de repositorio como GitMCP, la IA puede entender mejor el template, pero no reemplaza el comportamiento propio del MCP del framework.
140+
```
141+
77142
## Qué debe esperar el usuario siempre
78143

79144
Para un uso amigable de principiante, la IA debe responder en este orden:

docs/es/44-modelo-onboarding-mcp-alojado.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Corto plazo:
9797
- mantener `sdd-mcp` local para operaciones
9898
- publicar docs que definan el contrato de la capa alojada
9999
- usar el transporte HTTP actual como base conceptual
100+
- usar opcionalmente `GitMCP` como capa externa gratuita de contexto del repo público
100101

101102
Mediano plazo:
102103
- alojar un endpoint MCP de onboarding orientado a lectura
@@ -106,6 +107,25 @@ Mediano plazo:
106107
Largo plazo:
107108
- ofrecer un launcher de un clic o un bridge local delgado que la capa alojada pueda orquestar a través del cliente
108109

110+
## Dónde encaja `GitMCP`
111+
112+
`GitMCP` sirve como capa externa gratuita para repositorios públicos.
113+
114+
Qué sí puede hacer bien:
115+
- permitir que clientes IA lean y entiendan este repositorio de forma remota
116+
- exponer docs y estructura pública con casi cero setup
117+
- ayudar en descubrimiento, demos y difusión
118+
119+
Qué no debe considerarse:
120+
- un reemplazo de `sdd-mcp`
121+
- un reemplazo de tus prompts y comportamiento de producto
122+
- un escritor seguro dentro del proyecto local del usuario
123+
124+
Entonces la forma correcta de explicarlo es:
125+
- `GitMCP` o similar = contexto externo del repo
126+
- MCP alojado de onboarding = tu capa remota propia de guía
127+
- `sdd-mcp` local = capa operativa local de ejecución
128+
109129
## Contrato mínimo alojado
110130

111131
El MCP alojado de onboarding debería ofrecer al menos:

0 commit comments

Comments
 (0)