mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-02 00:04:45 -08:00
chore: enhance project metadata, tooling, and documentation
**Project Configuration:** - Enhance pyproject.toml with comprehensive metadata, keywords, and classifiers - Add LICENSE file (MIT) for proper open-source distribution - Add PUBLISHING.md with comprehensive publishing guidelines - Update .gitignore to exclude tool artifacts (.cache, .pytest_cache, .ruff_cache, .ty_cache) - Ignore documentation working directories (.docs, .full-review, docs/plans, docs/sessions) **Documentation:** - Add extensive Unraid API research documentation - API source code analysis and resolver mapping - Competitive analysis and feature gap assessment - Release notes analysis (7.0.0, 7.1.0, 7.2.0) - Connect platform overview and remote access documentation - Document known API patterns, limitations, and edge cases **Testing & Code Quality:** - Expand test coverage across all tool modules - Add destructive action confirmation tests - Improve test assertions and error case validation - Refine type annotations for better static analysis **Tool Improvements:** - Enhance error handling consistency across all tools - Improve type safety with explicit type annotations - Refine GraphQL query construction patterns - Better handling of optional parameters and edge cases This commit prepares the project for v0.2.0 release with improved metadata, comprehensive documentation, and enhanced code quality. Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Jacob Magar
139
docs/research/raw/blog-api-bounty.md
Normal file
139
docs/research/raw/blog-api-bounty.md
Normal file
@@ -0,0 +1,139 @@
|
||||
* [Unraid News](https://unraid.net/blog)
|
||||
|
||||
|
||||
5 September 2025
|
||||
|
||||
Introducing the Unraid API Feature Bounty Program
|
||||
=================================================
|
||||
|
||||
We’re opening new doors for developers and power users to directly shape the Unraid experience, together.
|
||||
|
||||
The new [Unraid API](https://docs.unraid.net/API/)
|
||||
has already come a long way as a powerful, open-source toolkit that unlocks endless possibilities for automation, integrations, and third-party applications. With each release, we’ve seen the creativity of our community take center stage, building tools that extend the Unraid experience in ways we never imagined.
|
||||
|
||||
Now, we’re taking it one step further with the [**Unraid API Feature Bounty Program**.](https://unraid.net/feature-bounty)
|
||||
|
||||
### **What Is the Feature Bounty Program?**
|
||||
|
||||
The bounty program gives developers (and adventurous users) a way to directly contribute to the Unraid API roadmap. Here’s how it works:
|
||||
|
||||
1. **Feature Requests Become Bounties:** We post specific API features that would benefit the entire Unraid ecosystem.
|
||||
2. **You Build & Contribute:** Developers who implement these features can claim the bounty, earn recognition, and a monetary reward.
|
||||
3. **Community Driven Growth:** Instead of waiting for features to arrive, you can help build them, get rewarded, and help the Unraid community.
|
||||
|
||||
Our core team focuses on high-priority roadmap items. Bounties give the community a way to help accelerate other highly requested features by bringing more ideas to life, faster, with recognition and reward for those who contribute.
|
||||
|
||||
API Feature Bounty Program Details
|
||||
----------------------------------
|
||||
|
||||
You can turn feature requests into reality, get rewarded for your contributions, and help grow the open-source Unraid API ecosystem.
|
||||
|
||||
[Learn More](https://unraid.net/feature-bounty)
|
||||
|
||||
### **The Open-Source Unraid API**
|
||||
|
||||
Alongside the bounty program, we’re thrilled to highlight just how open and flexible the Unraid API has become. Whether you’re scripting via the CLI, building automations with the API, or integrating with external identity providers through OAuth2/OIDC, the API is designed to be transparent and extensible.
|
||||
|
||||
API Docs
|
||||
--------
|
||||
|
||||
Learn about how to get started with the Unraid API.
|
||||
|
||||
[Start Here](https://docs.unraid.net/API/)
|
||||
|
||||
OIDC Provider Setup
|
||||
-------------------
|
||||
|
||||
Configure OIDC providers for SSO authentication in the Unraid API using the web interface.
|
||||
|
||||
[OIDC](https://docs.unraid.net/API/oidc-provider-setup/)
|
||||
|
||||
Upcoming API Features
|
||||
---------------------
|
||||
|
||||
The roadmap outlines completed and planned features for the Unraid API. Features and timelines may change based on development priorities and community feedback.
|
||||
|
||||
[Learn More](https://docs.unraid.net/API/upcoming-features/)
|
||||
|
||||
Community API Projects in Action
|
||||
--------------------------------
|
||||
|
||||
The power of an open API is best shown by what you build with it. Here are just a few highlights from the community so far!
|
||||
|
||||
|
||||
|
||||
### [Unraid Mobile App](https://forums.unraid.net/topic/189522-unraid-mobile-app/)
|
||||
|
||||
by S3ppo
|
||||
|
||||
|
||||
|
||||
### [Homepage Dashboard Widget](https://discord.com/channels/216281096667529216/1379497640110063656)
|
||||
|
||||
by surf108
|
||||
|
||||
|
||||
|
||||
### [Home Assistant Integration](https://github.com/domalab/ha-unraid-connect)
|
||||
|
||||
by domalab
|
||||
|
||||
|
||||
|
||||
[Unloggarr (AI-powered log analysis)](https://github.com/jmagar/unloggarr)
|
||||
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
by jmagar
|
||||
|
||||
|
||||
|
||||
[nzb360 Mobile App (Android)](https://play.google.com/store/apps/details?id=com.kevinforeman.nzb360&hl=en_US)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
by nzb360dev
|
||||
|
||||
|
||||
|
||||
[API Show and Tell](https://discord.com/channels/216281096667529216/1375651142704566282)
|
||||
|
||||
-----------------------------------------------------------------------------------------
|
||||
|
||||
Show off your project or see them all in action on our Discord channel!
|
||||
|
||||
Get Involved
|
||||
------------
|
||||
|
||||
Whether you’re a developer looking to contribute, or a user eager to see your most-wanted features come to life, the new Unraid API Feature Bounty Program is your chance to help shape the future of Unraid. The Unraid API is open and the bounties are live!
|
||||
|
||||
* #### [Feature Bounty Program](https://unraid.net/feature-bounty)
|
||||
|
||||
Learn More about the Feature Bounty Program
|
||||
|
||||
* #### [Claim Bounties](https://github.com/orgs/unraid/projects/3/views/1)
|
||||
|
||||
Browse the live bounty board
|
||||
|
||||
* #### [API Info](https://docs.unraid.net/API/)
|
||||
|
||||
Read the API Docs
|
||||
|
||||
|
||||
|
||||
|
||||
Pricing
|
||||
-------
|
||||
|
||||
With affordable options starting at just $49, we have a license for everyone.
|
||||
|
||||
[Buy Now](https://account.unraid.net/buy)
|
||||
|
||||
|
||||
|
||||
Try before you buy
|
||||
------------------
|
||||
|
||||
Not sure if Unraid is right for you? Take Unraid for a test drive for 30 days—no credit card required.
|
||||
|
||||
[Free Trial](https://unraid.net/getting-started)
|
||||
Reference in New Issue
Block a user