<div align="center">

# 🤖 Roba Labs MCP Server v0.1.0

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
[![MCP Protocol](https://img.shields.io/badge/MCP-2024--11--05-blue)](https://modelcontextprotocol.io)
[![Roba Labs](https://img.shields.io/badge/Roba_Labs-Robotics-orange)](https://roba-labs.gitbook.io/roba-labs)

**Model Context Protocol (MCP) server for Roba Labs**

[Features](#-features) • [Quick Start](#-quick-start) • [Tools](#-available-tools) • [Examples](#-usage-examples) • [Security](#-security)

</div>

---

## 🚀 Features

### 🤖 **Robotics Information Hub**
- **Platform Overview** - Complete information about Roba Labs ecosystem
- **Framework Catalog** - 15+ robotics frameworks (ROS, ROS2, Gazebo, Isaac Sim, PyBullet, MuJoCo)
- **Robot Types** - 13+ robot categories with detailed specifications
- **Learning Resources** - 20+ curated tutorials and documentation
- **Development Roadmap** - 4-phase platform development plan
- **Self-contained Data** - No external API required, works offline

### 🏗️ **Professional Architecture**
- Built on MCP Protocol 2024-11-05 specification
- Dual-server support (HTTP + MCP stdio for Claude Desktop)
- Comprehensive test coverage (19/19 tests passing)
- Clean, modular code structure with JSDoc documentation
- Zero-configuration deployment with sensible defaults
- 5 specialized tools for robotics information access

---

## 📦 Quick Start

> **Note:** This MCP server provides curated robotics information without requiring external APIs. Perfect for AI assistants helping with robotics development!

### ✅ Prerequisites
```bash
# Required
Node.js >= 18.0.0
npm >= 9.0.0
```

### 📥 Installation

```bash
# Clone the repository
git clone https://github.com/Tairon-ai/roba-labs-mcp.git
cd roba-labs-mcp

# Install dependencies
npm install

# Start the HTTP server
npm start

# Development mode
npm run dev

# MCP stdio server for Claude Desktop
npm run mcp
```

### 🤖 Claude Desktop Integration

Add to your Claude Desktop configuration:

```json
{
  "mcpServers": {
    "roba-labs": {
      "command": "node",
      "args": ["/path/to/roba-labs-mcp/mcp/index.js"]
    }
  }
}
```

> **Note:** No environment variables required - all data is self-contained!

---

## 🛠 Available Tools

### 🌐 **Platform Information**

| Tool | Description | Parameters | Returns |
|------|-------------|------------|---------|
| `get_roba_info` | Get comprehensive Roba Labs platform information | None | Platform overview, features, links, token utility |

### 🔧 **Robotics Frameworks**

| Tool | Description | Parameters | Returns |
|------|-------------|------------|---------|
| `list_frameworks` | List robotics frameworks with documentation | `category` (optional): "simulation", "middleware", "physics" | Framework catalog with ROS, ROS2, Gazebo, Isaac Sim, PyBullet, MuJoCo, etc. |

### 🤖 **Robot Types**

| Tool | Description | Parameters | Returns |
|------|-------------|------------|---------|
| `list_robot_types` | Get robot types with characteristics | `category` (optional): "mobile", "manipulator", "aerial", "specialized" | Robot catalog with complexity levels, sensors, use cases |

### 📚 **Learning Resources**

| Tool | Description | Parameters | Returns |
|------|-------------|------------|---------|
| `get_resources` | Get curated learning materials | `topic` (optional): "getting_started", "advanced", "frameworks", "tutorials", "community" | Tutorials, documentation links, community resources |

### 🗺️ **Platform Roadmap**

| Tool | Description | Parameters | Returns |
|------|-------------|------------|---------|
| `get_roadmap` | Get Roba Labs development roadmap | None | 4-phase roadmap, upcoming features, how to get involved |

---

## 🤖 Usage Examples

### 💬 Example Prompts for AI Assistants

#### 🌐 **Platform Information**
```
"Tell me about Roba Labs platform"
"What is Roba Labs?"
"Show me Roba Labs features and links"
"What's the ROBA token used for?"
```

#### 🔧 **Framework Queries**
```
"What robotics frameworks are available?"
"Show me simulation frameworks"
"List ROS and ROS2 details"
"What's the difference between Gazebo and Isaac Sim?"
"Which framework should I use for drone simulation?"
```

#### 🤖 **Robot Type Queries**
```
"What types of robots are there?"
"Show me mobile robots"
"What are the characteristics of manipulator robots?"
"List aerial robots and drones"
"What sensors do autonomous cars need?"
```

#### 📚 **Learning Resource Queries**
```
"How do I get started with ROS?"
"Show me ROS2 tutorials"
"Where can I learn about robotics simulation?"
"What are good resources for beginners?"
"Find me advanced robotics tutorials"
```

#### 🗺️ **Roadmap Queries**
```
"What's the Roba Labs roadmap?"
"Show me upcoming features"
"What phase is Roba Labs in now?"
"How can I contribute to Roba Labs?"
```

---

## 🚀 Deployment

### 🏭 Production Deployment

```bash
# Start production server
NODE_ENV=production npm start

# With PM2
pm2 start server.js --name roba-labs-mcp

# With Docker
docker build -t roba-labs-mcp .
docker run -d -p 8080:8080 roba-labs-mcp
```

### 🔍 Health Check

```bash
# Check server health
curl http://localhost:8080/health

# Get server info
curl http://localhost:8080/info
```

---

## 🔒 Security & Privacy

### 🛡️ Security Features

- **No API Keys Needed** - Self-contained operation, no authentication required
- **No External Requests** - All data is local, works completely offline
- **No Data Collection** - No user data collected or transmitted
- **Open Source** - Full code transparency and auditing
- **Local Processing** - All operations happen on your machine

### 🔐 Best Practices

- **No Credentials Required** - No sensitive data to protect
- **Offline Capable** - Works without internet connection
- **Zero Rate Limiting** - No external service dependencies
- **Full Privacy** - No telemetry or tracking

---

## 📊 Supported Data

### 🌐 Robotics Frameworks (15+)
- **Middleware**: ROS, ROS2
- **Simulation**: Gazebo, Isaac Sim (NVIDIA), PyBullet, MuJoCo
- **Physics**: ODE, Bullet Physics, Simbody, DART

### 🤖 Robot Types (13+)
- **Mobile Robots**: Differential drive, mecanum, autonomous cars
- **Manipulators**: 6-DOF arms, collaborative robots, dual-arm systems
- **Aerial**: Quadcopters, fixed-wing drones
- **Specialized**: Humanoids, quadrupeds, underwater ROVs

### 📚 Learning Resources (20+)
- Official ROS/ROS2 tutorials
- Framework documentation
- Community forums and Q&A
- Video courses and guides

### 🗺️ Roadmap Information
- 4 development phases
- Feature timeline
- Contribution opportunities

---

## 📈 Performance

- **Response Time**: < 1ms (local data)
- **Offline Capable**: Works without internet
- **Zero Latency**: No network requests
- **Test Coverage**: 19/19 tests passing (100%)
- **Reliability**: No external service dependencies

---

## 🤝 Contributing

We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) for details on how to get started.

```bash
# Fork and clone
git clone https://github.com/Tairon-ai/roba-labs-mcp.git

# Create feature branch
git checkout -b feature/your-feature

# Make changes and test
npm test

# Commit and push
git commit -m 'feat: add your feature'
git push origin feature/your-feature

# Open Pull Request
```

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and development process.

---

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

## 🙏 Acknowledgments

- [Roba Labs](https://roba-labs.gitbook.io/roba-labs) - Open robotics development platform
- [MCP Protocol](https://modelcontextprotocol.io) - Model Context Protocol specification
- [ROS](https://www.ros.org/) - Robot Operating System
- [Open Source Robotics Community](https://www.openrobotics.org/) - Framework development

---

## 📚 Resources

- [Roba Labs Documentation](https://roba-labs.gitbook.io/roba-labs)
- [MCP Protocol Specification](https://modelcontextprotocol.io)
- [ROS Documentation](https://www.ros.org/)
- [ROS 2 Documentation](https://docs.ros.org/)

---

<div align="center">

**Built by [Tairon.ai](https://tairon.ai) team with help from Claude**

</div>