Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
47f11b3d95 | ||
|
|
f24be8ff53 | ||
|
|
dfff432321 |
38
README.md
38
README.md
@@ -63,15 +63,7 @@ bun install --frozen-lockfile # ♻️ Reliable dep tree
|
|||||||
|
|
||||||
# Start in dev mode with hot-reload 🔥
|
# Start in dev mode with hot-reload 🔥
|
||||||
bun run dev --watch
|
bun run dev --watch
|
||||||
```
|
``` |
|
||||||
|
|
||||||
## 🚦 Rate Limiting Tiers
|
|
||||||
|
|
||||||
| Plan | Requests/min | Features | Cache TTL |
|
|
||||||
|---------------|--------------|------------------------|-------------|
|
|
||||||
| Free | 100 | Basic controls | 5min |
|
|
||||||
| Pro | 1,000 | Priority queue | 1hr |
|
|
||||||
| Enterprise | 10,000 | Dedicated cache | Custom |
|
|
||||||
|
|
||||||
## 💡 Example Usage
|
## 💡 Example Usage
|
||||||
|
|
||||||
@@ -108,9 +100,7 @@ docker system prune # Clean old images 🧹
|
|||||||
| Platform | Link | Response Time |
|
| Platform | Link | Response Time |
|
||||||
|----------------|-------------------------------|---------------|
|
|----------------|-------------------------------|---------------|
|
||||||
| 📚 Docs | [API Reference](docs/api.md) | Instant |
|
| 📚 Docs | [API Reference](docs/api.md) | Instant |
|
||||||
| 💬 Discord | [Join Chat](#) | <1hr |
|
|
||||||
| 🐛 GitHub | [Issues](#) | <24hr |
|
| 🐛 GitHub | [Issues](#) | <24hr |
|
||||||
| 🐦 Twitter | [@HomeMCP](#) | <2hr |
|
|
||||||
|
|
||||||
## 🚧 Troubleshooting Guide
|
## 🚧 Troubleshooting Guide
|
||||||
|
|
||||||
@@ -134,7 +124,7 @@ docker exec mcp_redis redis-cli info memory
|
|||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
We love community input! Here's how to help:
|
I love community input! Here's how to help:
|
||||||
|
|
||||||
1. 🍴 Fork the repository
|
1. 🍴 Fork the repository
|
||||||
2. 🌿 Create a feature branch
|
2. 🌿 Create a feature branch
|
||||||
@@ -143,8 +133,6 @@ We love community input! Here's how to help:
|
|||||||
5. 📦 Commit using [Conventional Commits](https://www.conventionalcommits.org)
|
5. 📦 Commit using [Conventional Commits](https://www.conventionalcommits.org)
|
||||||
6. 🔀 Open a Pull Request
|
6. 🔀 Open a Pull Request
|
||||||
|
|
||||||
**Pro Tip:** Check our [Good First Issues](https://github.com/jango-blockchained/homeassistant-mcp/contribute) for starter tasks! 🎯
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**📢 Note:** This project adheres to [Semantic Versioning](https://semver.org). Always check breaking changes in release notes before upgrading! ⚠️
|
**📢 Note:** This project adheres to [Semantic Versioning](https://semver.org). Always check breaking changes in release notes before upgrading! ⚠️
|
||||||
@@ -255,15 +243,15 @@ For additional details, check out our [Roadmap](docs/roadmap.md).
|
|||||||
|
|
||||||
## Community & Support
|
## Community & Support
|
||||||
|
|
||||||
Join our community to stay updated, share ideas, and get help:
|
Join the community to stay updated, share ideas, and get help:
|
||||||
|
|
||||||
- **GitHub Issues:** Report bugs or suggest features on our [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues).
|
- **GitHub Issues:** Report bugs or suggest features on the [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues).
|
||||||
- **Discussion Forums:** Connect with other users and contributors in our community forums.
|
- **Discussion Forums:** Connect with other users and contributors in the community forums.
|
||||||
- **Chat Platforms:** Join our real-time discussions on [Discord](#) or [Slack](#).
|
- **Chat Platforms:** Join real-time discussions on [Discord](#) or [Slack](#).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We welcome your contributions! To get started:
|
I welcome your contributions! To get started:
|
||||||
|
|
||||||
1. Fork the repository.
|
1. Fork the repository.
|
||||||
2. Create your feature branch:
|
2. Create your feature branch:
|
||||||
@@ -300,11 +288,11 @@ A: MCP Server runs on Linux, macOS, and Windows (Docker is recommended for Windo
|
|||||||
|
|
||||||
**Q: How do I report a bug or request a feature?**
|
**Q: How do I report a bug or request a feature?**
|
||||||
|
|
||||||
A: Please use our [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues) to report bugs or request new features.
|
A: Please use the [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues) to report bugs or request new features.
|
||||||
|
|
||||||
**Q: Can I contribute to the project?**
|
**Q: Can I contribute to the project?**
|
||||||
|
|
||||||
A: Absolutely! We welcome contributions from the community. See the [Contributing](#contributing) section for more details.
|
A: Absolutely! I welcome contributions from the community. See the [Contributing](#contributing) section for more details.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -312,10 +300,4 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for the f
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Full documentation is available at: [https://jango-blockchained.github.io/homeassistant-mcp/](https://jango-blockchained.github.io/homeassistant-mcp/)
|
Full documentation is available at: [https://jango-blockchained.github.io/homeassistant-mcp/](https://jango-blockchained.github.io/homeassistant-mcp/)
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
@@ -5,6 +5,8 @@ gem "jekyll-theme-minimal"
|
|||||||
gem "jekyll-relative-links"
|
gem "jekyll-relative-links"
|
||||||
gem "jekyll-seo-tag"
|
gem "jekyll-seo-tag"
|
||||||
gem "jekyll-remote-theme"
|
gem "jekyll-remote-theme"
|
||||||
|
gem "jekyll-github-metadata"
|
||||||
|
gem "faraday-retry"
|
||||||
|
|
||||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||||
# and associated library.
|
# and associated library.
|
||||||
|
|||||||
@@ -3,8 +3,12 @@ description: A bridge between Home Assistant and Language Learning Models
|
|||||||
theme: jekyll-theme-minimal
|
theme: jekyll-theme-minimal
|
||||||
markdown: kramdown
|
markdown: kramdown
|
||||||
|
|
||||||
|
# Repository settings
|
||||||
|
repository: jango-blockchained/advanced-homeassistant-mcp
|
||||||
|
github: [metadata]
|
||||||
|
|
||||||
# Add base URL and URL settings
|
# Add base URL and URL settings
|
||||||
baseurl: "/homeassistant-mcp" # the subpath of your site, e.g. /blog
|
baseurl: "/advanced-homeassistant-mcp" # the subpath of your site
|
||||||
url: "https://jango-blockchained.github.io" # the base hostname & protocol
|
url: "https://jango-blockchained.github.io" # the base hostname & protocol
|
||||||
|
|
||||||
# Theme settings
|
# Theme settings
|
||||||
@@ -15,6 +19,7 @@ plugins:
|
|||||||
- jekyll-relative-links
|
- jekyll-relative-links
|
||||||
- jekyll-seo-tag
|
- jekyll-seo-tag
|
||||||
- jekyll-remote-theme
|
- jekyll-remote-theme
|
||||||
|
- jekyll-github-metadata
|
||||||
|
|
||||||
# Enable relative links
|
# Enable relative links
|
||||||
relative_links:
|
relative_links:
|
||||||
@@ -70,55 +75,4 @@ exclude:
|
|||||||
# Sass settings
|
# Sass settings
|
||||||
sass:
|
sass:
|
||||||
style: compressed
|
style: compressed
|
||||||
sass_dir: _sass
|
sass_dir: _sass
|
||||||
|
|
||||||
# Enable relative links
|
|
||||||
relative_links:
|
|
||||||
enabled: true
|
|
||||||
collections: true
|
|
||||||
|
|
||||||
# Navigation structure
|
|
||||||
header_pages:
|
|
||||||
- index.md
|
|
||||||
- getting-started.md
|
|
||||||
- api.md
|
|
||||||
- usage.md
|
|
||||||
- tools/tools.md
|
|
||||||
- development/development.md
|
|
||||||
- troubleshooting.md
|
|
||||||
- contributing.md
|
|
||||||
- roadmap.md
|
|
||||||
|
|
||||||
# Collections
|
|
||||||
collections:
|
|
||||||
tools:
|
|
||||||
output: true
|
|
||||||
permalink: /:collection/:name
|
|
||||||
development:
|
|
||||||
output: true
|
|
||||||
permalink: /:collection/:name
|
|
||||||
|
|
||||||
# Default layouts
|
|
||||||
defaults:
|
|
||||||
- scope:
|
|
||||||
path: ""
|
|
||||||
type: "pages"
|
|
||||||
values:
|
|
||||||
layout: "default"
|
|
||||||
- scope:
|
|
||||||
path: "tools"
|
|
||||||
type: "tools"
|
|
||||||
values:
|
|
||||||
layout: "default"
|
|
||||||
- scope:
|
|
||||||
path: "development"
|
|
||||||
type: "development"
|
|
||||||
values:
|
|
||||||
layout: "default"
|
|
||||||
|
|
||||||
# Exclude files from processing
|
|
||||||
exclude:
|
|
||||||
- Gemfile
|
|
||||||
- Gemfile.lock
|
|
||||||
- node_modules
|
|
||||||
- vendor
|
|
||||||
Reference in New Issue
Block a user