Skip to content

Commit d4c79f5

Browse files
committed
docs(mcp): make complete reference the primary entrypoint
1 parent befb5af commit d4c79f5

7 files changed

Lines changed: 32 additions & 15 deletions

README.es.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ npm run build
5555
- Ejemplo para Cursor: [`packages/sdd-mcp/examples/.cursor/mcp.json`](./packages/sdd-mcp/examples/.cursor/mcp.json)
5656
- Ejemplo para Codex: [`packages/sdd-mcp/examples/codex.config.toml`](./packages/sdd-mcp/examples/codex.config.toml)
5757

58-
3. Lee la guía de instalación:
58+
3. Lee en este orden:
59+
- [docs/es/41-referencia-completa-mcp.md](./docs/es/41-referencia-completa-mcp.md)
5960
- [docs/es/33-guia-servidor-mcp.md](./docs/es/33-guia-servidor-mcp.md)
6061
- [docs/es/40-referencia-resultados-comandos.md](./docs/es/40-referencia-resultados-comandos.md)
61-
- [docs/es/41-referencia-completa-mcp.md](./docs/es/41-referencia-completa-mcp.md)
6262

6363
## 🎬 Flujo rápido de adopción
6464

@@ -174,9 +174,9 @@ Paquete obligatorio por feature:
174174

175175
- Esenciales: [Estructura](./docs/es/01-estructura.md) · [Flujo](./docs/es/02-flujo-de-trabajo.md)
176176
- IA: [Agentes soportados](./docs/es/10-agentes-ia-soportados-y-prompts.md) · [Guía Lovable](./docs/es/17-trabajar-con-lovable.md)
177-
- MCP: [Guía del servidor MCP](./docs/es/33-guia-servidor-mcp.md)
177+
- MCP: [Referencia completa](./docs/es/41-referencia-completa-mcp.md)
178+
- Setup MCP: [Guía del servidor](./docs/es/33-guia-servidor-mcp.md)
178179
- Resultado por comando: [Referencia](./docs/es/40-referencia-resultados-comandos.md)
179-
- Tools MCP: [Referencia completa](./docs/es/41-referencia-completa-mcp.md)
180180
- Setup clientes: [Recetas](./docs/es/36-recetas-setup-clientes.md)
181181
- Versionado: [Estrategia](./docs/es/37-estrategia-versionado.md)
182182
- Roadmap: [Roadmap público](./docs/es/35-roadmap-publico.md)

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ npm run build
5555
- Cursor example: [`packages/sdd-mcp/examples/.cursor/mcp.json`](./packages/sdd-mcp/examples/.cursor/mcp.json)
5656
- Codex example: [`packages/sdd-mcp/examples/codex.config.toml`](./packages/sdd-mcp/examples/codex.config.toml)
5757

58-
3. Read the setup guide:
58+
3. Read in this order:
59+
- [docs/en/41-complete-mcp-reference.md](./docs/en/41-complete-mcp-reference.md)
5960
- [docs/en/33-mcp-server-guide.md](./docs/en/33-mcp-server-guide.md)
6061
- [docs/en/40-command-results-reference.md](./docs/en/40-command-results-reference.md)
61-
- [docs/en/41-complete-mcp-reference.md](./docs/en/41-complete-mcp-reference.md)
6262

6363
## 🎬 Fast Adoption Flow
6464

@@ -174,9 +174,9 @@ Mandatory spec bundle (for each feature):
174174

175175
- Essentials: [Structure](./docs/en/01-structure.md) · [Workflow](./docs/en/02-workflow.md)
176176
- AI: [Supported Agents](./docs/en/10-supported-ai-agents-and-prompts.md) · [Lovable Guide](./docs/en/17-working-with-lovable.md)
177-
- MCP: [MCP Server Guide](./docs/en/33-mcp-server-guide.md)
178-
- Command Results: [Reference](./docs/en/40-command-results-reference.md)
179-
- MCP Tools: [Complete Reference](./docs/en/41-complete-mcp-reference.md)
177+
- MCP: [Complete Reference](./docs/en/41-complete-mcp-reference.md)
178+
- MCP Setup: [Server Guide](./docs/en/33-mcp-server-guide.md)
179+
- MCP Results: [Command Reference](./docs/en/40-command-results-reference.md)
180180
- Client Setup: [Recipes](./docs/en/36-client-setup-recipes.md)
181181
- Versioning: [Strategy](./docs/en/37-versioning-strategy.md)
182182
- Roadmap: [Public Roadmap](./docs/en/35-public-roadmap.md)

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ flowchart LR
4545
## Core SDD references / Referencias SDD base
4646
- Workflow: [EN](./en/02-workflow.md) | [ES](./es/02-flujo-de-trabajo.md)
4747
- Spec Kit integration: [EN](./en/08-github-spec-kit-integration.md) | [ES](./es/08-integracion-github-spec-kit.md)
48+
- MCP complete reference: [EN](./en/41-complete-mcp-reference.md) | [ES](./es/41-referencia-completa-mcp.md)
4849
- MCP server guide: [EN](./en/33-mcp-server-guide.md) | [ES](./es/33-guia-servidor-mcp.md)
4950
- Launch kit: [EN](./en/34-launch-kit.md) | [ES](./es/34-kit-lanzamiento.md)
5051
- Public roadmap: [EN](./en/35-public-roadmap.md) | [ES](./es/35-roadmap-publico.md)

docs/en/33-mcp-server-guide.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Purpose
44

5-
This guide explains how to run, connect, and use the local `sdd-mcp` server as the operational MCP layer of this framework.
5+
This guide is only for MCP setup and connectivity.
6+
7+
If you want the full functional reference, start here:
8+
- [Complete MCP Reference](./41-complete-mcp-reference.md)
69

710
Product split:
811
- repository root: canonical SDD framework
@@ -11,6 +14,8 @@ Product split:
1114

1215
## What is already implemented
1316

17+
High-level summary only:
18+
1419
Transports:
1520
- `stdio`
1621
- `Streamable HTTP`
@@ -81,9 +86,9 @@ Entrypoints:
8186
- do not implement code before approved spec and consistent plan
8287
- request explicit user consent only when implementation is about to start
8388

84-
See also:
85-
- [Command Results Reference](./40-command-results-reference.md)
89+
Related references:
8690
- [Complete MCP Reference](./41-complete-mcp-reference.md)
91+
- [Command Results Reference](./40-command-results-reference.md)
8792

8893
## Copy-paste config examples
8994

docs/en/40-command-results-reference.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
This guide documents what each core script and MCP tool creates, modifies, and returns.
66

7+
For the complete MCP overview, tool intent, resources, and prompts, start here:
8+
- [Complete MCP Reference](./41-complete-mcp-reference.md)
9+
710
## Workspace and bootstrap scripts
811

912
### `./scripts/create-www-project.sh <project-name> <assistant> [flags]`

docs/es/33-guia-servidor-mcp.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Propósito
44

5-
Esta guía explica cómo ejecutar, conectar y usar el servidor local `sdd-mcp` como la capa MCP operativa de este framework.
5+
Esta guía es solo para setup y conectividad MCP.
6+
7+
Si quieres la referencia funcional completa, empieza aquí:
8+
- [Referencia completa de MCP](./41-referencia-completa-mcp.md)
69

710
Separación del producto:
811
- raíz del repositorio: framework SDD canónico
@@ -11,6 +14,8 @@ Separación del producto:
1114

1215
## Lo que ya está implementado
1316

17+
Resumen de alto nivel solamente:
18+
1419
Transportes:
1520
- `stdio`
1621
- `Streamable HTTP`
@@ -81,9 +86,9 @@ Entrypoints:
8186
- no implementes código antes de tener spec aprobada y plan consistente
8287
- solicita consentimiento explícito solo cuando la implementación vaya a comenzar
8388

84-
Ver también:
85-
- [Referencia de resultados por comando](./40-referencia-resultados-comandos.md)
89+
Referencias relacionadas:
8690
- [Referencia completa de MCP](./41-referencia-completa-mcp.md)
91+
- [Referencia de resultados por comando](./40-referencia-resultados-comandos.md)
8792

8893
## Ejemplos listos para copiar
8994

docs/es/40-referencia-resultados-comandos.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
Esta guía documenta qué crea, qué modifica y qué devuelve cada script principal y cada tool MCP.
66

7+
Para la visión completa de MCP, intención de tools, resources y prompts, empieza aquí:
8+
- [Referencia completa de MCP](./41-referencia-completa-mcp.md)
9+
710
## Scripts de workspace e inicialización
811

912
### `./scripts/create-www-project.sh <nombre-proyecto> <assistant> [flags]`

0 commit comments

Comments
 (0)