float-mcp

# Float MCP Server Documentation\n\nWelcome to the comprehensive documentation for the Float MCP Server. This directory contains all the documentation you need to understand, integrate, and use the Float MCP Server effectively.\n\n## 📖 **Quick Start**\n\n- **[README.md](../README.md)** - Main project overview, installation, and quick start guide\n- **[Integration Guide](guides/CLAUDE_INTEGRATION_GUIDE.md)** - Step-by-step integration with Claude Desktop\n- **[API Usage Guide](guides/API_USAGE_GUIDE.md)** - How to use the Float API tools effectively\n\n## 🔧 **API Documentation**\n\n- **[API Documentation](api/API_DOCUMENTATION.md)** - Complete reference for all Float API endpoints\n- **[Tool Reference](api/TOOL_REFERENCE.md)** - Detailed documentation of all MCP tools available\n\n## 🧪 **Testing & Quality**\n\n- **[Integration Testing](testing/INTEGRATION_TESTING.md)** - Guide to running and understanding integration tests\n- **[Test Coverage Reports](testing/)** - Test coverage and quality metrics\n\n## 🏗️ **Architecture & Development**\n\n### Code Organization\n- **[Source Code Structure](architecture/CODE_STRUCTURE.md)** - How the codebase is organized\n- **[API Layer](architecture/API_LAYER.md)** - Float API integration architecture\n- **[MCP Tools](architecture/MCP_TOOLS.md)** - How MCP tools are structured and created\n\n### Data Models\n- **[Schema Definitions](api/SCHEMAS.md)** - Zod schemas for Float API data validation\n- **[Type Definitions](api/TYPES.md)** - TypeScript type definitions\n\n## 📋 **Reference**\n\n### Configuration\n- **[Environment Variables](reference/ENVIRONMENT.md)** - All supported environment variables\n- **[Configuration Options](reference/CONFIG.md)** - Available configuration options\n\n### Error Handling\n- **[Error Types](reference/ERRORS.md)** - Complete error handling reference\n- **[Troubleshooting](reference/TROUBLESHOOTING.md)** - Common issues and solutions\n\n### Performance\n- **[Rate Limiting](reference/RATE_LIMITING.md)** - Understanding Float API rate limits\n- **[Optimization Guide](reference/OPTIMIZATION.md)** - Performance best practices\n\n## 🔍 **Examples**\n\n### Basic Usage\n- **[People Management](examples/PEOPLE.md)** - Managing people and team members\n- **[Project Management](examples/PROJECTS.md)** - Creating and managing projects\n- **[Time Tracking](examples/TIME_TRACKING.md)** - Logging and managing time entries\n- **[Time Off Management](examples/TIME_OFF.md)** - Managing time off requests\n\n### Advanced Usage\n- **[Bulk Operations](examples/BULK_OPERATIONS.md)** - Performing bulk data operations\n- **[Custom Workflows](examples/WORKFLOWS.md)** - Building custom business workflows\n- **[Reporting](examples/REPORTING.md)** - Generating reports and analytics\n\n## 🚀 **Deployment**\n\n- **[Docker Deployment](deployment/DOCKER.md)** - Running with Docker\n- **[Production Setup](deployment/PRODUCTION.md)** - Production deployment guidelines\n- **[Security Considerations](deployment/SECURITY.md)** - Security best practices\n\n## 🤝 **Contributing**\n\n- **[Development Setup](contributing/DEVELOPMENT.md)** - Setting up the development environment\n- **[Contributing Guidelines](../CONTRIBUTING.md)** - How to contribute to the project\n- **[Code Style Guide](contributing/STYLE_GUIDE.md)** - Coding standards and conventions\n\n## 📚 **Additional Resources**\n\n### External Documentation\n- **[Float API Documentation](https://developer.float.com/)** - Official Float API reference\n- **[Model Context Protocol](https://modelcontextprotocol.io/)** - MCP specification and documentation\n- **[Claude Desktop](https://claude.ai/desktop)** - Claude Desktop application\n\n### Community\n- **[GitHub Issues](https://github.com/yourusername/float-mcp/issues)** - Report bugs and request features\n- **[GitHub Discussions](https://github.com/yourusername/float-mcp/discussions)** - Community discussions\n\n---\n\n## 🗂️ **Documentation Status**\n\n| Document | Status | Last Updated |\n|----------|--------|--------------|\n| README.md | ✅ Complete | Current |\n| API Documentation | ✅ Complete | Current |\n| Integration Guide | ✅ Complete | Current |\n| Tool Reference | ✅ Complete | Current |\n| Testing Guide | ✅ Complete | Current |\n| Architecture Docs | 🚧 In Progress | - |\n| Examples | 🚧 In Progress | - |\n| Deployment Guides | 📝 Planned | - |\n\n---\n\n> **Need help?** Check the [troubleshooting guide](reference/TROUBLESHOOTING.md) or [open an issue](https://github.com/yourusername/float-mcp/issues) on GitHub.