Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
3a5d1d9dc2 | |||
03be4f202c |
39
README.md
39
README.md
@ -1,5 +1,22 @@
|
|||||||
# mcrentcast - Rentcast MCP Server
|
# mcrentcast - Rentcast MCP Server
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://app.rentcast.io/assets/svg/brand/logo.svg" alt="Rentcast Logo" width="200"/>
|
||||||
|
|
||||||
|
<h3>MCP Server for Rentcast API</h3>
|
||||||
|
<p>Intelligent property data access with advanced caching, rate limiting, and cost management</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://www.rentcast.io/api">API Home</a> •
|
||||||
|
<a href="https://developers.rentcast.io/reference/introduction">Documentation</a> •
|
||||||
|
<a href="https://git.supported.systems/MCP/mcrentcast">Repository</a>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> **The Rentcast real estate and property data API provides on-demand access to 140+ million property records, owner details, home value and rent estimates, comparable properties, active sale and rental listings, as well as aggregate real estate market data.**
|
||||||
|
|
||||||
A Model Context Protocol (MCP) server that provides intelligent access to the Rentcast API with advanced caching, rate limiting, and cost management features.
|
A Model Context Protocol (MCP) server that provides intelligent access to the Rentcast API with advanced caching, rate limiting, and cost management features.
|
||||||
|
|
||||||
## 🌟 Features
|
## 🌟 Features
|
||||||
@ -484,12 +501,24 @@ The server provides complete access to Rentcast API endpoints:
|
|||||||
| **Market Data** | Statistics and trends | `get_market_statistics` |
|
| **Market Data** | Statistics and trends | `get_market_statistics` |
|
||||||
| **Management** | Configuration and monitoring | 6 management tools |
|
| **Management** | Configuration and monitoring | 6 management tools |
|
||||||
|
|
||||||
### Cost Management
|
### 💰 API Pricing & Cost Management
|
||||||
|
|
||||||
|
#### Rentcast API Pricing
|
||||||
|
Rentcast offers several pricing tiers for API access. See [official pricing](https://www.rentcast.io/api#api-pricing) for current rates:
|
||||||
|
- **Free Tier**: Limited requests for testing
|
||||||
|
- **Basic**: $99/month for 1,000 requests
|
||||||
|
- **Professional**: Higher volumes with bulk pricing
|
||||||
|
- **Enterprise**: Custom pricing for large-scale usage
|
||||||
|
|
||||||
|
> **Why We Cache**: Each API request costs money! Our [intelligent caching system](#-features) stores responses for 24 hours (configurable), dramatically reducing costs by serving repeated requests from cache instead of making new API calls. This can reduce API costs by 70-90% in typical usage patterns.
|
||||||
|
|
||||||
|
#### Cost Management Features
|
||||||
- **Automatic Cost Estimation**: Know before you spend
|
- **Automatic Cost Estimation**: Know before you spend
|
||||||
- **User Confirmations**: Approve expensive operations
|
- **User Confirmations**: Approve expensive operations
|
||||||
- **Usage Tracking**: Monitor daily/monthly consumption
|
- **Usage Tracking**: Monitor daily/monthly consumption
|
||||||
- **Smart Caching**: Minimize redundant API calls
|
- **Smart Caching**: Minimize redundant API calls
|
||||||
|
- **Rate Limiting**: Prevent accidental overuse
|
||||||
|
- **Cache Analytics**: Track hit rates and savings
|
||||||
- **Mock API**: Unlimited testing without credits
|
- **Mock API**: Unlimited testing without credits
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
@ -513,12 +542,18 @@ Contributions are welcome! Please:
|
|||||||
|
|
||||||
## 📞 Support
|
## 📞 Support
|
||||||
|
|
||||||
### Documentation Resources
|
### Project Documentation
|
||||||
- **[Installation Guide](docs/INSTALLATION.md)**: Complete setup instructions
|
- **[Installation Guide](docs/INSTALLATION.md)**: Complete setup instructions
|
||||||
- **[Usage Examples](docs/USAGE.md)**: All 13 tools with real-world examples
|
- **[Usage Examples](docs/USAGE.md)**: All 13 tools with real-world examples
|
||||||
- **[Mock API Testing](docs/mock-api.md)**: Test without consuming credits
|
- **[Mock API Testing](docs/mock-api.md)**: Test without consuming credits
|
||||||
- **[Claude Integration](docs/claude-setup.md)**: MCP configuration help
|
- **[Claude Integration](docs/claude-setup.md)**: MCP configuration help
|
||||||
|
|
||||||
|
### Rentcast API Resources
|
||||||
|
- **[API Documentation](https://developers.rentcast.io/reference/introduction)**: Official API reference
|
||||||
|
- **[API Pricing](https://www.rentcast.io/api#api-pricing)**: Current pricing tiers
|
||||||
|
- **[API Dashboard](https://app.rentcast.io)**: Manage your API keys
|
||||||
|
- **[Rentcast Support](https://www.rentcast.io/contact)**: Official support channel
|
||||||
|
|
||||||
### Getting Help
|
### Getting Help
|
||||||
- **Issues**: [Create an issue](https://git.supported.systems/MCP/mcrentcast/issues) on the repository
|
- **Issues**: [Create an issue](https://git.supported.systems/MCP/mcrentcast/issues) on the repository
|
||||||
- **Discussions**: Use GitHub discussions for questions and community support
|
- **Discussions**: Use GitHub discussions for questions and community support
|
||||||
|
Loading…
x
Reference in New Issue
Block a user