Document Schema Specifications

Uma coleção de esquemas de documentos para padronizar a documentação de projetos em diversos projetos de software.

GitHub

Documentação

Especificações de Esquemas de Documentos

Uma coleção abrangente de esquemas de documentos para padronizar a documentação de projetos em diferentes tipos de projetos de software.

✨ Principais Recursos

  • 📋 Coleção de Esquemas de Documentos - Mais de 10 esquemas cobrindo todos os aspectos da documentação de projetos
  • 🌐 Integração com a API do GitHub - 191 modelos de repositórios oficiais do GitHub
  • 🔍 Validação em Tempo Real - Verificação automatizada da estrutura de documentos
  • 📦 Pronto para NPX - Instalação e execução fáceis via npx
  • 🤖 Amigável para IA - Projetado para integração perfeita com assistentes de IA
  • ⚡ Geração de Modelos - Criação instantânea de documentos padronizados

🚀 Início Rápido com 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

📋 Integração com a API do GitHub

🔄 Acesso a Modelos em Tempo Real

🛡️ Sistema de Fallback

  • Principal: API do GitHub para modelos mais recentes
  • Fallback: Modelos locais quando a API não está disponível
  • Nenhuma configuração necessária

📁 Coleção de Esquemas

Este projeto fornece esquemas para os seguintes tipos de documentos:

  • README - Introdução do projeto e instruções de configuração
  • Documentação da API - Documentação da interface de código
  • Arquitetura - Design do sistema e estrutura de componentes
  • Recursos - Descrições de funcionalidades voltadas ao usuário
  • Stack de Tecnologias - Escolhas de tecnologia e dependências
  • TODO - Tarefas ativas de desenvolvimento e acompanhamento
  • Backlog - Ideias futuras e recursos adiados
  • Changelog - Histórico de versões e alterações
  • Contribuição - Diretrizes de contribuição e configuração
  • Prompts - Modelos e padrões de prompts para IA

🚀 Uso

Implementação Manual

  1. Navegue pelos esquemas no diretório schemas/
  2. Copie a estrutura de esquema relevante para o seu projeto
  3. Preencha o conteúdo de acordo com o formato especificado

Com o Servidor MCP (Recomendado)

Use nosso servidor Model Context Protocol com 9 ferramentas poderosas:

🔧 Opções de Instalação

# 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

🛠️ Ferramentas do Servidor MCP (9 no Total)

📋 Ferramentas de Documentos:

  • validate_document - Validar documentos contra esquemas
  • generate_template - Criar novos modelos de documentos
  • list_schemas - Listar esquemas de documentos disponíveis
  • analyze_project_docs - Avaliar a completude da documentação

📄 Ferramentas de Licença:

  • generate_license - Gerar arquivos de licença (mais de 36 modelos do GitHub)
  • list_license_templates - Listar todos os modelos de licença disponíveis

🚫 Ferramentas de Gitignore:

  • generate_gitignore - Gerar arquivos .gitignore (mais de 155 modelos do GitHub)
  • list_gitignore_templates - Listar todos os modelos de gitignore disponíveis

📊 Ferramentas Gerais:

  • list_templates - Listar todos os modelos disponíveis (esquemas + licenças + gitignores)

🔌 Integração com Claude Desktop

Adicione às suas configurações do MCP (claude_desktop_config.json):

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

📂 Estrutura de Arquivos

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

📦 Pacote NPM

O servidor MCP é publicado como @scriptonbasestar/sb-schema-doc-server:

🤝 Contribuição

Por favor, leia nossas Diretrizes de Contribuição para detalhes sobre nosso código de conduta e o processo para envio de pull requests.

📄 Licença

Licença MIT - consulte o arquivo LICENSE para mais detalhes.