@shipstreaks/mcp-server/README.md

MCP server for ShipStreaks - AI-powered project tracking and daily check-ins for builders. Use with Claude Desktop, Cursor, and other MCP-compatible AI tools.

# @shipstreaks/mcp-server

Official MCP (Model Context Protocol) server for [ShipStreaks](https://shipstreaks.app) - AI-powered project tracking and daily check-ins for builders who ship.

> ⚠️ **Important**: Please use version 1.0.4 or later. Earlier versions have been deprecated due to API endpoint issues.

## Features

- 🤖 **AI-Powered Project Creation**: Extract project details from any URL (GitHub, docs, etc.)
- ✨ **Automated Check-ins**: Generate check-ins from commits, PRs, or deployment logs
- 🔥 **Streak Tracking**: Monitor your building streak directly from your AI assistant
- 🌐 **Web Content Extraction**: Use Firecrawl to intelligently parse project information
- 🚀 **Simple Setup**: Just copy a JSON config - works with Claude, Cursor, and any MCP client

## Quick Start

### 1. Install via NPX (Recommended)

No installation needed! Just add to your MCP client configuration:

```json
{
  "mcpServers": {
    "shipstreaks": {
      "command": "npx",
      "args": ["-y", "@shipstreaks/mcp-server@latest"],
      "env": {
        "SHIPSTREAKS_API_KEY": "your-api-key-here",
        "SHIPSTREAKS_BASE_URL": "https://mcp.shipstreaks.app"
      }
    }
  }
}
```

### 2. Local Installation

```bash
npm install -g @shipstreaks/mcp-server
```

Then add to your MCP configuration:

```json
{
  "mcpServers": {
    "shipstreaks": {
      "command": "shipstreaks-mcp",
      "env": {
        "SHIPSTREAKS_API_KEY": "your-api-key-here",
        "SHIPSTREAKS_BASE_URL": "https://mcp.shipstreaks.app"
      }
    }
  }
}
```

## Configuration

### Required Environment Variables

- `SHIPSTREAKS_API_KEY`: Your ShipStreaks API key (get from [dashboard settings](https://shipstreaks.app/dashboard/settings/api-keys))

### Optional Environment Variables

- `FIRECRAWL_API_KEY`: Enable web content extraction (get from firecrawl.dev)
- `SHIPSTREAKS_BASE_URL`: Custom API endpoint (default: https://mcp.shipstreaks.app)

## Available Tools

### 1. create_project
Create a new ShipStreaks project with optional URL extraction.

**Example prompts:**
- "Create a new project from https://github.com/user/awesome-app"
- "Create a web app project called TaskMaster for managing daily tasks"

### 2. create_checkin
Submit a daily check-in to maintain your streak.

**Example prompts:**
- "Create a check-in for project-123: Implemented user authentication"
- "Check in with today's GitHub commits for my main project"

### 3. list_projects
View all your ShipStreaks projects.

**Example prompts:**
- "Show me all my projects"
- "List my active projects"

### 4. get_streak_status
Check your current streak and stats.

**Example prompts:**
- "What's my current streak?"
- "Show my ShipStreaks stats"

### 5. extract_project_from_url
Extract project information from any URL.

**Example prompts:**
- "Extract project info from https://myapp.com"
- "Analyze this GitHub repo and create a project"

## IDE Setup

### Claude Desktop

1. Open Claude Desktop settings
2. Go to Developer → Model Context Protocol
3. Add the configuration above
4. Restart Claude Desktop

### Cursor

1. Open Settings (Cmd/Ctrl + ,)
2. Search for "MCP"
3. Add the configuration to MCP Servers
4. Reload window

### VS Code (with Continue.dev)

1. Install Continue extension
2. Open Continue settings
3. Add MCP server configuration
4. Restart VS Code

## Usage Examples

### Creating a Project from GitHub

```
You: Create a ShipStreaks project from https://github.com/vercel/next.js