Document Schema Specifications

Especificaciones de Esquemas de Documentos

Una colección completa de esquemas de documentos para estandarizar la documentación de proyectos en diferentes tipos de proyectos de software.

✨ Características Clave

• 📋 Colección de Esquemas de Documentos - Más de 10 esquemas que cubren todos los aspectos de la documentación de proyectos
• 🌐 Integración con la API de GitHub - 191 plantillas de repositorios oficiales de GitHub
• 🔍 Validación en Tiempo Real - Verificación automatizada de la estructura de documentos
• 📦 Listo para NPX - Instalación y ejecución sencillas mediante npx
• 🤖 Amigable con IA - Diseñado para una integración fluida con asistentes de IA
• ⚡ Generación de Plantillas - Creación instantánea de documentos estandarizados

🚀 Inicio Rápido con NPX

# Install and run the MCP server globally
npx @scriptonbasestar/sb-schema-doc-server

# Generate a MIT license
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "generate_license", "arguments": {"license_type": "mit", "author": "Your Name", "output_path": "LICENSE"}}}' | npx @scriptonbasestar/sb-schema-doc-server

# Generate a Node.js .gitignore
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "generate_gitignore", "arguments": {"gitignore_type": "Node", "output_path": ".gitignore"}}}' | npx @scriptonbasestar/sb-schema-doc-server

# List all available templates
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "list_templates", "arguments": {}}}' | npx @scriptonbasestar/sb-schema-doc-server

📋 Integración con la API de GitHub

🔄 Acceso a Plantillas en Tiempo Real

• Plantillas de Licencias: 36 plantillas de licenses/license-templates
• Plantillas de Gitignore: 155 plantillas de github/gitignore
• Esquemas de Documentos: 10 esquemas locales para documentación de proyectos

🛡️ Sistema de Respaldo

• Principal: API de GitHub para las plantillas más recientes
• Respaldo: Plantillas locales cuando la API no está disponible
• No se requiere configuración

📁 Colección de Esquemas

Este proyecto proporciona esquemas para los siguientes tipos de documentos:

• README - Introducción al proyecto e instrucciones de configuración
• Documentación de API - Documentación de interfaces de código
• Arquitectura - Diseño del sistema y estructura de componentes
• Características - Descripciones de funcionalidades orientadas al usuario
• Stack Tecnológico - Elecciones tecnológicas y dependencias
• TODO - Tareas de desarrollo activas y seguimiento
• Backlog - Ideas futuras y características diferidas
• Registro de Cambios - Historial de versiones y cambios
• Contribución - Directrices de contribución y configuración
• Prompts - Plantillas y estándares de prompts para IA

🚀 Uso

Implementación Manual

1. Explore los esquemas en el directorio schemas/
2. Copie la estructura de esquema relevante a su proyecto
3. Complete el contenido según el formato especificado

Con Servidor MCP (Recomendado)

Use nuestro servidor de Protocolo de Contexto de Modelo con 9 herramientas potentes:

🔧 Opciones de Instalación

# Option 1: NPX (Recommended)
npx @scriptonbasestar/sb-schema-doc-server

# Option 2: Global Installation
npm install -g @scriptonbasestar/sb-schema-doc-server
document-schema-doc-server

# Option 3: Local Development
git clone https://github.com/archmagece/mcp-schema-specs.git
cd mcp-schema-specs/doc-server
npm install && npm run build && npm start

🛠️ Herramientas del Servidor MCP (9 en Total)

📋 Herramientas de Documentos:

• validate_document - Validar documentos contra esquemas
• generate_template - Crear nuevas plantillas de documentos
• list_schemas - Listar esquemas de documentos disponibles
• analyze_project_docs - Evaluar la completitud de la documentación

📄 Herramientas de Licencias:

• generate_license - Generar archivos de licencia (más de 36 plantillas de GitHub)
• list_license_templates - Listar todas las plantillas de licencias disponibles

🚫 Herramientas de Gitignore:

• generate_gitignore - Generar archivos .gitignore (más de 155 plantillas de GitHub)
• list_gitignore_templates - Listar todas las plantillas de gitignore disponibles

📊 Herramientas Generales:

• list_templates - Listar todas las plantillas disponibles (esquemas + licencias + gitignores)

🔌 Integración con Claude Desktop

Agregue a su configuración de MCP (claude_desktop_config.json):

{
  "mcpServers": {
    "sb-schema-server": {
      "command": "npx",
      "args": ["@scriptonbasestar/sb-schema-doc-server"]
    }
  }
}

📂 Estructura de Archivos

mcp-schema-specs/
├── schemas/                    # Document and template specifications
│   ├── docs/                   # Document schema definitions
│   │   ├── schema.readme.md   # README structure
│   │   ├── schema.api.md      # API documentation
│   │   └── ...                # Other schema files
│   └── templates/             # Local template fallbacks
│       ├── licenses/          # License templates
│       └── gitignore/         # Gitignore templates
├── doc-server/                # MCP server implementation
│   ├── src/index.ts          # Server source code
│   ├── package.json          # NPM package configuration
│   ├── README.md             # Server documentation
│   └── build/                # Compiled JavaScript
└── README.md                  # Project overview

📦 Paquete NPM

El servidor MCP se publica como @scriptonbasestar/sb-schema-doc-server:

• Uso con NPX: npx @scriptonbasestar/sb-schema-doc-server
• Instalación Global: npm install -g @scriptonbasestar/sb-schema-doc-server
• URL del Paquete: https://www.npmjs.com/package/@scriptonbasestar/sb-schema-doc-server

🤝 Contribución

Por favor, lea nuestras Directrices de Contribución para obtener detalles sobre nuestro código de conducta y el proceso para enviar solicitudes de extracción.

📄 Licencia

Licencia MIT - consulte el archivo LICENSE para más detalles.