Skip to main content

Get Started in 5 Minutes

Choose your product below and follow the setup guide. All plans include a 14-day free trial with no credit card required.

Documentation Quick Start

Set up AI-powered semantic documentation search for your repositories.

What You’ll Need

  • GitHub, GitLab, Bitbucket, or Gitea account with repositories
  • Claude Desktop, VSCode, Cursor, or any MCP-compatible IDE
  • 5 minutes of setup time

Step 1: Create Your Account

1

Sign Up

Go to app.ulpi.io and click Sign Up
2

Choose Authentication

Sign in with Google or GitHub (OAuth)
3

Select Plan

Choose your Documentation plan:
  • Starter: $29/mo (5 repos, 100k tokens)
  • Pro: $99/mo (25 repos, 500k tokens)
  • Enterprise: $299/mo (unlimited repos, 2M tokens)
Start your 14-day free trial - no credit card required

Step 2: Connect Your Repositories

1

Navigate to Repositories

In the ULPI dashboard, click Repositories in the sidebar
2

Connect Version Control

Click Connect Repository and choose your provider:
  • GitHub
  • GitLab
  • Bitbucket
  • Gitea (self-hosted)
3

Authorize Access

Grant ULPI.io read access to your repositories. We only need read permissions to index documentation.
4

Select Repositories

Choose which repositories contain documentation you want to search. You can select multiple repositories.
5

Configure Branches

For each repository, select which branches to index:
  • main or master (production docs)
  • develop (development docs)
  • Custom branches (feature branches, staging, etc.)
6

Wait for Indexing

ULPI will automatically index your documentation. Time varies by repository size:
  • Small repos (< 100 files): 1-2 minutes
  • Medium repos (100-1000 files): 2-5 minutes
  • Large repos (> 1000 files): 5-15 minutes
Auto-Indexing: ULPI automatically re-indexes your docs on every push via webhooks. No manual updates needed.

Step 3: Create an API Key

API keys authenticate your AI assistant with ULPI.io.
1

Go to API Keys

Click API Keys in the ULPI dashboard sidebar
2

Create New Key

Click Create API Key button
3

Configure Settings

Name: Descriptive name (e.g., “Claude Desktop - MacBook Pro”)Environment: Choose one:
  • sandbox - For testing with fake data
  • live - For production use (select this)
Type: Choose one:
  • full_access - All permissions (easiest for getting started)
  • restricted - Specific scopes only (more secure)
Scopes (if restricted):
  • Leave default for Documentation product
  • Tenant-scoped by default (access to all your repos)
4

Save Your Key

IMPORTANT: Copy the API key immediately. You won’t see it again!Format: ulpi_live_... or ulpi_sandbox_...Store it securely (password manager, environment variable, etc.)
Security: Anyone with your API key can access your documentation. Never commit API keys to version control or share them publicly.

Step 4: Configure Your IDE

Configure your MCP-compatible IDE (Claude Desktop, VSCode, Cursor, Windsurf, Zed, etc.):Example Configuration - Claude Desktop:
  1. Open Claude Desktop settings
  2. Navigate to DeveloperEdit Config
  3. Add ULPI MCP server:
{
  "mcpServers": {
    "ulpi-docs": {
      "command": "npx",
      "args": ["-y", "@ulpi/mcp-server"],
      "env": {
        "ULPI_API_KEY": "ulpi_live_your_api_key_here"
      }
    }
  }
}
  1. Restart Claude Desktop
  2. Look for ULPI tools in the tools panel

    Step 5: Try It Out!

    Ask your AI assistant to search your documentation: Example Queries:
"Search my documentation for authentication examples"
"Find all API endpoint documentation in the user-service repository"
"Show me documentation about database migrations on the develop branch"
"List all repositories with documentation indexed"
Available MCP Tools:
  • search_documentation - Semantic search across all docs
  • expand_document - Get full content of specific documents
  • list_repositories - Browse indexed repositories

What’s Next?

Manage Repositories

Add more repos and configure branches

API Keys Guide

Manage scopes and security

Search Best Practices

Get better search results

Webhook Setup

Configure auto-indexing

Troubleshooting

Common issues and solutions

Need Help?

Read the FAQ

Common questions answered

Contact Support

Get help from our team

Join Discord

Community support