Commit Graph

9 Commits

Author SHA1 Message Date
jango-blockchained
5f078ff227 docs: update environment variable naming from NODE_ENV to BUN_ENV 2025-02-04 14:56:22 +01:00
jango-blockchained
02284c787b docs: add contributing guidelines and project roadmap
- Create CONTRIBUTING.md with comprehensive guidelines for community contributions
- Develop ROADMAP.md outlining near-term, mid-term, and long-term project goals
- Provide clear instructions for code style, testing, and community engagement
- Define project vision and future enhancement strategies
2025-02-04 04:28:26 +01:00
jango-blockchained
3e97357561 docs: update documentation to use Bun commands and scripts
- Replace npm commands with equivalent Bun commands in GETTING_STARTED.md
- Update TESTING.md to reflect Bun-specific test and development scripts
- Simplify installation, development, and testing instructions
2025-02-04 04:17:58 +01:00
jango-blockchained
cb897d4cf6 docs: add comprehensive architecture documentation for MCP Server
- Create ARCHITECTURE.md with detailed system design overview
- Describe key architectural components including Bun runtime, SSE communication, and modular design
- Highlight security, performance, and scalability features
- Outline future enhancement roadmap
- Provide insights into system design principles and technology choices
2025-02-04 04:14:43 +01:00
jango-blockchained
790a37e49f refactor: migrate to Elysia and enhance security middleware
- Replaced Express with Elysia for improved performance and type safety
- Integrated Elysia middleware for rate limiting, security headers, and request validation
- Refactored security utilities to work with Elysia's context and request handling
- Updated token management and validation logic
- Added comprehensive security headers and input sanitization
- Simplified server initialization and error handling
- Updated documentation with new setup and configuration details
2025-02-04 03:09:35 +01:00
jango-blockchained
18f09bb5ce Add comprehensive documentation for Home Assistant MCP project
- Created detailed getting started guide with installation and configuration instructions
- Added main documentation README with structured table of contents
- Developed troubleshooting guide with common issues, debugging tips, and FAQ
- Included development guide with project structure, setup, and contribution guidelines
- Added tools documentation with overview of available management tools
2025-02-03 15:38:55 +01:00
jango-blockchained
cb6b16546b Refactor API Documentation with Comprehensive MCP Schema and Endpoint Details
- Completely restructured API.md with a more modular and detailed approach
- Added comprehensive schema documentation for MCP endpoint
- Expanded sections on device control, add-on management, and core functions
- Included WebSocket event handling and real-time update mechanisms
- Enhanced error handling and rate limiting documentation
- Added example usage sections with curl and JavaScript demonstrations
- Improved overall readability and technical depth of API reference
2025-02-03 00:28:07 +01:00
jango-blockchained
e1e0a45acc Add Server-Sent Events (SSE) API documentation and README updates
- Created comprehensive SSE API documentation in `docs/SSE_API.md`
- Updated README.md with new features section highlighting SSE capabilities
- Added `.cursornotes` file for SSE subscription flow
- Provided detailed examples and usage guidelines for SSE integration
- Documented event types, authentication, and best practices for real-time updates
2025-01-30 12:21:25 +01:00
jango-blockchained
70c9287c68 Add comprehensive Home Assistant MCP API documentation
- Created detailed API documentation for Home Assistant Model Context Protocol (MCP)
- Documented authentication, rate limiting, and security best practices
- Included comprehensive endpoint descriptions for:
  * Natural Language Processing
  * Device Control
  * History
  * Scenes
  * Automations
  * Add-ons
  * Package Management
- Added WebSocket event handling and connection examples
- Provided error handling and response format guidelines
2025-01-30 11:04:21 +01:00