Quick Start

Get up and running with ContextPin in 5 minutes.

Get ContextPin connected to your favorite AI tool and start documenting your codebase in minutes.

Step 1: Install ContextPin

Download and install ContextPin for your platform:

  1. Go to the Download page
  2. Download ContextPin for macOS
  3. Open the .dmg and drag ContextPin to Applications
  4. Launch ContextPin

For detailed installation instructions, see the Installation guide.

Step 2: Connect to Your AI Tool

ContextPin uses the Model Context Protocol (MCP) to share contexts with AI tools. Choose your tool and follow the setup:

Tool Setup Guide
Claude Desktop View Guide
Claude Code (CLI) View Guide
Cursor View Guide
Windsurf View Guide
VS Code + Copilot View Guide

Quick Setup (Claude Desktop)

  1. In ContextPin, go to Settings → MCP
  2. Click Copy Configuration
  3. Open Claude Desktop's config file: 
    ~/Library/Application Support/Claude/claude_desktop_config.json
  4. Paste the configuration and save
  5. Restart Claude Desktop

Step 3: Document Your Repository

Now for the magic. Open your AI tool and use this prompt to instantly generate comprehensive documentation for any repository: 

Analyze this repository and save a comprehensive documentation context to ContextPin. Include:

1. **Project Overview** - What this project does, its purpose, and key features
2. **Tech Stack** - Languages, frameworks, and major dependencies
3. **Architecture** - High-level structure, main components, and how they interact
4. **Key Patterns** - Coding conventions, design patterns, and best practices used
5. **Getting Started** - How to set up, run, and develop locally
6. **Important Files** - Entry points, config files, and critical modules to understand

The AI will analyze your codebase and save the documentation directly to ContextPin via MCP. Now every future conversation with any AI tool will have instant access to your project's documentation.

Example Workflow

Once you have your repository documented: 

"Read my Project Overview context and help me add a new feature for user notifications"

"Based on my Architecture context, where should I add the payment processing logic?"

"Using my Key Patterns context, review this PR for consistency with our codebase"

Using Context URIs

Every context in ContextPin has a unique URI that you can drag or paste directly into coding agents like Claude Code, Codex, and others.

Get a Context URI

Drag and Drop — The fastest way:

  1. Drag any context from the ContextPin sidebar
  2. Drop it directly into your coding agent's input
  3. The context URI is automatically inserted

Right-Click to Copy:

  1. Right-click on any context in ContextPin
  2. Select Copy Context URI
  3. Paste into your coding agent's prompt

URI Format

Context URIs use a unique identifier: 

contextpin://VzHcAwyl

Each context has its own unique ID, for example: 

contextpin://VzHcAwyl    (API Guidelines)
contextpin://Kp3mNx8q    (Project Overview)
contextpin://Rt7wYj2s    (Coding Standards)

Using with Coding Agents

Paste URIs directly into prompts for Claude Code, Codex, and other coding agents: 

# Reference a specific context
"Read contextpin://VzHcAwyl and review this endpoint"

# Use multiple contexts
"Using contextpin://Kp3mNx8q and contextpin://Rt7wYj2s,
help me add a new service layer"

# Quick documentation lookup
"What does contextpin://Bm4xLp9n say about token refresh?"
Pro tip: Keep frequently-used context URIs in a text file or shell alias for quick access.

What's Next?