Document Schema Specifications MCP Server
Kumpulan skema dokumen untuk menstandarisasi dokument
Dokumentasi
Document Schema Specifications
A comprehensive collection of document schemas for standardizing project documentation across different types of software projects.
โจ Key Features
- ๐ Document Schema Collection - 10+ schemas covering all aspects of project documentation
- ๐ GitHub API Integration - 191 templates from official GitHub repositories
- ๐ Real-time Validation - Automated document structure checking
- ๐ฆ NPX Ready - Easy installation and execution via npx
- ๐ค AI-Friendly - Designed for seamless AI assistant integration
- โก Template Generation - Instant creation of standardized documents
๐ Quick Start with 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
๐ GitHub API Integration
๐ Real-time Template Access
- License Templates: 36 templates from licenses/license-templates
- Gitignore Templates: 155 templates from github/gitignore
- Document Schemas: 10 local schemas for project documentation
๐ก๏ธ Fallback System
- Primary: GitHub API for latest templates
- Fallback: Local templates when API unavailable
- Zero configuration required
๐ Schema Collection
This project provides schemas for the following document types:
- README - Project introduction and setup instructions
- API Documentation - Code interface documentation
- Architecture - System design and component structure
- Features - User-facing functionality descriptions
- Tech Stack - Technology choices and dependencies
- TODO - Active development tasks and tracking
- Backlog - Future ideas and deferred features
- Changelog - Version history and changes
- Contributing - Contribution guidelines and setup
- Prompts - AI prompt templates and standards
๐ Usage
Manual Implementation
- Browse the schemas in the
schemas/directory - Copy the relevant schema structure to your project
- Fill in the content according to the specified format
With MCP Server (Recommended)
Use our Model Context Protocol server with 9 powerful tools:
๐ง Installation Options
# 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
๐ ๏ธ MCP Server Tools (9 Total)
๐ Document Tools:
validate_document- Validate documents against schemasgenerate_template- Create new document templateslist_schemas- List available document schemasanalyze_project_docs- Assess documentation completeness
๐ License Tools:
generate_license- Generate license files (36+ templates from GitHub)list_license_templates- List all available license templates
๐ซ Gitignore Tools:
generate_gitignore- Generate .gitignore files (155+ templates from GitHub)list_gitignore_templates- List all available gitignore templates
๐ General Tools:
list_templates- List all available templates (schemas + licenses + gitignores)
๐ Claude Desktop Integration
Add to your MCP settings (claude_desktop_config.json):
{
"mcpServers": {
"sb-schema-server": {
"command": "npx",
"args": ["@scriptonbasestar/sb-schema-doc-server"]
}
}
}
๐ File Structure
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
๐ฆ NPM Package
The MCP server is published as @scriptonbasestar/sb-schema-doc-server:
- NPX Usage:
npx @scriptonbasestar/sb-schema-doc-server - Global Install:
npm install -g @scriptonbasestar/sb-schema-doc-server - Package URL: https://www.npmjs.com/package/@scriptonbasestar/sb-schema-doc-server
๐ค Contributing
Please read our Contributing Guidelines for details on our code of conduct and the process for submitting pull requests.
๐ License
MIT License - see the LICENSE file for details.