> ## Documentation Index
> Fetch the complete documentation index at: https://ulpi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get up and running with ULPI.io in 5 minutes

## 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.

<Tabs>
  <Tab title="Documentation">
    ## 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

    <Steps>
      <Step title="Sign Up">
        Go to [app.ulpi.io](https://app.ulpi.io) and click **Sign Up**
      </Step>

      <Step title="Choose Authentication">
        Sign in with **Google** or **GitHub** (OAuth)
      </Step>

      <Step title="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>
    </Steps>

    ***

    ### Step 2: Connect Your Repositories

    <Steps>
      <Step title="Navigate to Repositories">
        In the ULPI dashboard, click **Repositories** in the sidebar
      </Step>

      <Step title="Connect Version Control">
        Click **Connect Repository** and choose your provider:

        * GitHub
        * GitLab
        * Bitbucket
        * Gitea (self-hosted)
      </Step>

      <Step title="Authorize Access">
        Grant ULPI.io read access to your repositories. We only need read permissions to index documentation.
      </Step>

      <Step title="Select Repositories">
        Choose which repositories contain documentation you want to search. You can select multiple repositories.
      </Step>

      <Step title="Configure Branches">
        For each repository, select which branches to index:

        * `main` or `master` (production docs)
        * `develop` (development docs)
        * Custom branches (feature branches, staging, etc.)
      </Step>

      <Step title="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
      </Step>
    </Steps>

    <Note>
      **Auto-Indexing**: ULPI automatically re-indexes your docs on every push via webhooks. No manual updates needed.
    </Note>

    ***

    ### Step 3: Create an API Key

    API keys authenticate your AI assistant with ULPI.io.

    <Steps>
      <Step title="Go to API Keys">
        Click **API Keys** in the ULPI dashboard sidebar
      </Step>

      <Step title="Create New Key">
        Click **Create API Key** button
      </Step>

      <Step title="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)
      </Step>

      <Step title="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.)
      </Step>
    </Steps>

    <Warning>
      **Security**: Anyone with your API key can access your documentation. Never commit API keys to version control or share them publicly.
    </Warning>

    ***

    ### 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 **Developer** → **Edit Config**
    3. Add ULPI MCP server:

    ```json theme={null}
    {
      "mcpServers": {
        "ulpi-docs": {
          "command": "npx",
          "args": ["-y", "@ulpi/mcp-server"],
          "env": {
            "ULPI_API_KEY": "ulpi_live_your_api_key_here"
          }
        }
      }
    }
    ```

    4. Restart Claude Desktop
    5. 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?

    <CardGroup cols={3}>
      <Card title="Manage Repositories" icon="book-open" href="/repositories">
        Add more repos and configure branches
      </Card>

      <Card title="API Keys Guide" icon="key" href="/api-keys">
        Manage scopes and security
      </Card>

      <Card title="Search Best Practices" icon="magnifying-glass" href="/documentation/search-tips">
        Get better search results
      </Card>

      <Card title="Webhook Setup" icon="webhook" href="/repositories/webhooks">
        Configure auto-indexing
      </Card>

      <Card title="Troubleshooting" icon="circle-question" href="/faq">
        Common issues and solutions
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Skills">
    ## Skills Quick Start

    Set up custom AI coding workflows matched to your tech stack.

    ### What You'll Need

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

    ***

    ### Step 1: Create Your Account

    <Steps>
      <Step title="Sign Up">
        Go to [app.ulpi.io](https://app.ulpi.io) and click **Sign Up**
      </Step>

      <Step title="Choose Authentication">
        Sign in with **Google** or **GitHub** (OAuth)
      </Step>

      <Step title="Select Plan">
        Choose your Skills plan:

        * **Starter**: \$19/mo (5 skills, 50k tokens)
        * **Pro**: \$69/mo (25 skills, 300k tokens)
        * **Enterprise**: \$199/mo (unlimited skills, 1M tokens)

        Start your **14-day free trial** - no credit card required
      </Step>
    </Steps>

    ***

    ### Step 2: Connect Your Repositories

    <Steps>
      <Step title="Navigate to Repositories">
        In the ULPI dashboard, click **Repositories** in the sidebar
      </Step>

      <Step title="Connect Version Control">
        Click **Connect Repository** and choose your provider:

        * GitHub
        * GitLab
        * Bitbucket
        * Gitea (self-hosted)
      </Step>

      <Step title="Authorize Access">
        Grant ULPI.io read access to your repositories. We analyze your code to detect tech stack.
      </Step>

      <Step title="Select Repositories">
        Choose repositories you want to enable Skills for. Tech stack is automatically detected.
      </Step>

      <Step title="Review Tech Stack">
        ULPI detects your technologies automatically:

        * **Frameworks**: Laravel, React, Next.js, NestJS, etc.
        * **Languages**: PHP, JavaScript, TypeScript, Python, etc.
        * **Tools**: Docker, Git, Composer, npm, etc.
        * **Databases**: MySQL, PostgreSQL, MongoDB, Redis, etc.

        288+ technologies supported. You can manually add missing technologies.
      </Step>
    </Steps>

    <Note>
      **Tech Stack Matching**: Skills are automatically filtered based on your detected technologies. Laravel repos see Laravel skills, React repos see React skills, etc.
    </Note>

    ***

    ### Step 3: Create an API Key

    API keys authenticate your AI assistant with ULPI.io.

    <Steps>
      <Step title="Go to API Keys">
        Click **API Keys** in the ULPI dashboard sidebar
      </Step>

      <Step title="Create New Key">
        Click **Create API Key** button
      </Step>

      <Step title="Configure Settings">
        **Name**: Descriptive name (e.g., "Claude Desktop - Development")

        **Environment**: `live` (production use)

        **Type**: Choose one:

        * `full_access` - All permissions (recommended for Skills)
        * `restricted` - Specific scopes only

        **Scopes** (if restricted):

        * Select repositories you want to enable Skills for
        * Format: `repo:{repository_id}:skills`
        * Example: `repo:123:skills` enables Skills for repository 123
      </Step>

      <Step title="Save Your Key">
        **IMPORTANT**: Copy the API key immediately. You won't see it again!

        Store it securely (password manager, environment variable, etc.)
      </Step>
    </Steps>

    ***

    ### 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 **Developer** → **Edit Config**
    3. Add ULPI Skills MCP server:

    ```json theme={null}
    {
      "mcpServers": {
        "ulpi-skills": {
          "command": "npx",
          "args": ["-y", "@ulpi/mcp-server-skills"],
          "env": {
            "ULPI_API_KEY": "ulpi_live_your_api_key_here",
            "ULPI_REPOSITORY_ID": "123"
          }
        }
      }
    }
    ```

    4. Restart Claude Desktop

    5. Look for ULPI Skills tools in the tools panel

    ***

    ### Step 5: Try Your First Skill!

    Ask your AI assistant to use a skill:

    **Example Queries**:

    ```
    "Use the Create Laravel API Endpoint skill to build /api/posts"
    ```

    ```
    "Follow the Laravel Database Migration skill to create a users table"
    ```

    ```
    "Use the Git Commit Best Practices skill to write a commit message for these changes"
    ```

    ```
    "Show me what skills are available for my React project"
    ```

    **10 Public Skills Included**:

    1. **Create Laravel API Endpoint** - Build RESTful APIs with validation and tests
    2. **Create React Component** - TypeScript components with props and state
    3. **Laravel Database Migration** - Schema design with indexes and foreign keys
    4. **Git Commit Best Practices** - Conventional commit messages
    5. **API Documentation with OpenAPI** - REST API docs with OpenAPI 3.0
    6. **Write PHPUnit Tests** - Feature tests, unit tests, and factories
    7. **Setup Docker Container** - Dockerfiles and docker-compose configs
    8. **Database Query Optimization** - Optimize with indexes and query analysis
    9. **Implement Laravel Queue Job** - Async jobs with retries and batching
    10. **Create REST API Client** - HTTP clients with retries and auth

    [Browse Full Skill Library →](/skills)

    ***

    ### What's Next?

    <CardGroup cols={3}>
      <Card title="Browse Skills" icon="list-check" href="/skills">
        View all 10 public skills
      </Card>

      <Card title="Create Custom Skills" icon="sparkles" href="/skills/custom-skills">
        Build team-specific workflows
      </Card>

      <Card title="Tech Stack Matching" icon="layer-group" href="/skills/tech-stack-matching">
        How skills match your stack
      </Card>

      <Card title="API Keys Guide" icon="key" href="/api-keys">
        Manage scopes and security
      </Card>

      <Card title="Troubleshooting" icon="circle-question" href="/faq">
        Common issues and solutions
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Multiple Products">
    ## Complete Platform Setup

    Set up multiple ULPI products together for the full experience. Choose from Documentation, Skills, Memory, and Coordination.

    <Note>
      **Save Money**: Subscribe to a **Bundle** and save 12-20% compared to individual products. [View All Bundle Options →](/pricing)
    </Note>

    ### What You'll Need

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

    ***

    ### Step 1: Create Your Account

    <Steps>
      <Step title="Sign Up">
        Go to [app.ulpi.io](https://app.ulpi.io) and click **Sign Up**
      </Step>

      <Step title="Choose Authentication">
        Sign in with **Google** or **GitHub** (OAuth)
      </Step>

      <Step title="Select Bundle Plan">
        Choose a bundle combination and save:

        **Popular 2-Product Bundles:**

        * **Docs + Skills Starter**: $42/mo (save $6)
        * **Docs + Memory Starter**: $60/mo (save $8)
        * **Skills + Memory Starter**: $51/mo (save $7)

        **3-Product Bundles:**

        * **Docs + Skills + Memory Starter**: $74/mo (save $13)
        * **Docs + Skills + Coordination Starter**: $65/mo (save $12)

        **Complete Platform (All 4 Products):**

        * **Starter**: $93/mo (save $23)
        * **Pro**: $333/mo (save $83)
        * **Enterprise**: $1,037/mo (save $259)

        Start your **14-day free trial** - no credit card required

        [View All 33 Bundle Combinations →](/pricing)
      </Step>
    </Steps>

    ***

    ### Step 2: Connect Your Repositories

    <Steps>
      <Step title="Navigate to Repositories">
        In the ULPI dashboard, click **Repositories** in the sidebar
      </Step>

      <Step title="Connect Version Control">
        Click **Connect Repository** and choose your provider:

        * GitHub
        * GitLab
        * Bitbucket
        * Gitea (self-hosted)
      </Step>

      <Step title="Authorize Access">
        Grant ULPI.io read access to your repositories
      </Step>

      <Step title="Select Repositories">
        Choose repositories for the products you subscribed to
      </Step>

      <Step title="Enable Features">
        For each repository, configure the products you subscribed to:

        **Documentation** (if subscribed):

        * Select branches to index for documentation
        * Wait for initial indexing (1-15 minutes)

        **Skills** (if subscribed):

        * Tech stack is automatically detected
        * Skills are filtered by your technologies
        * Review and add missing technologies if needed

        **Memory** (if subscribed):

        * Memory is automatically available via MCP
        * No repository-specific setup needed

        **Coordination** (if subscribed):

        * Create a coordination project
        * Register agent identities
        * Configure contact policies
      </Step>
    </Steps>

    ***

    ### Step 3: Create API Keys

    You can use **one API key** for all products or create **separate keys** for better organization.

    <Tabs>
      <Tab title="Single Key (Recommended)">
        **Use one key for all ULPI products**

        <Steps>
          <Step title="Go to API Keys">
            Click **API Keys** in the ULPI dashboard sidebar
          </Step>

          <Step title="Create New Key">
            Click **Create API Key** button
          </Step>

          <Step title="Configure Settings">
            **Name**: "Claude Desktop - Full Access"

            **Environment**: `live`

            **Type**: `full_access` (grants access to all products)

            **Scopes**: Automatically includes all repositories
          </Step>

          <Step title="Save Your Key">
            Copy the API key: `ulpi_live_...`

            Store it securely
          </Step>
        </Steps>

        <Note>
          **Memory & Coordination**: Both products are automatically available via MCP with any valid API key. No additional repository-specific setup is needed.
        </Note>
      </Tab>

      <Tab title="Separate Keys">
        **Use different keys for different products**

        **Documentation API Key**:

        1. **Name**: "Claude Desktop - Documentation"
        2. **Type**: `restricted`
        3. **Scopes**: Tenant-scoped (default)
        4. Copy key: `ulpi_live_docs_...`

        **Skills API Key**:

        1. **Name**: "Claude Desktop - Skills"
        2. **Type**: `restricted`
        3. **Scopes**: Select specific repositories
           * Format: `repo:{id}:skills`
        4. Copy key: `ulpi_live_skills_...`

        **Memory & Coordination**:

        * Use your full access key or any tenant-scoped key
        * Both products work at the tenant level, not per-repository

        This approach gives you fine-grained control over which repositories have Documentation and Skills enabled.
      </Tab>
    </Tabs>

    ***

    ### Step 4: Configure Your IDE

    Add **both MCP servers** to your IDE configuration.

    **Claude Desktop Example**:

    1. Open Claude Desktop settings
    2. Navigate to **Developer** → **Edit Config**
    3. Add both MCP servers:

    ```json theme={null}
    {
      "mcpServers": {
        "ulpi-docs": {
          "command": "npx",
          "args": ["-y", "@ulpi/mcp-server"],
          "env": {
            "ULPI_API_KEY": "ulpi_live_your_api_key_here"
          }
        },
        "ulpi-skills": {
          "command": "npx",
          "args": ["-y", "@ulpi/mcp-server-skills"],
          "env": {
            "ULPI_API_KEY": "ulpi_live_your_api_key_here",
            "ULPI_REPOSITORY_ID": "123"
          }
        }
      }
    }
    ```

    4. Restart Claude Desktop
    5. Look for both ULPI Documentation and ULPI Skills tools

    ***

    ### Step 5: Complete Workflow Example

    Experience the power of Documentation + Skills working together:

    **Example 1: Context + Code Generation**

    ```
    You: "Search our authentication docs for how we handle JWT tokens"
    AI: [Uses Documentation MCP to find internal auth patterns]

    You: "Now use the Laravel API Endpoint skill to create /api/auth/login following our patterns"
    AI: [Uses Skills MCP to generate code matching your architecture]
    ```

    **Example 2: Learning + Implementation**

    ```
    You: "Find documentation about our database migration conventions"
    AI: [Searches your internal docs]

    You: "Use the Laravel Database Migration skill to create a users table following those conventions"
    AI: [Generates migration with your team's standards]
    ```

    **Example 3: Research + Best Practices**

    ```
    You: "Search for our Git commit message guidelines"
    AI: [Finds your team's commit standards]

    You: "Use the Git Commit Best Practices skill to write a commit for these changes"
    AI: [Generates commit message matching your conventions]
    ```

    ***

    ### What's Next?

    <CardGroup cols={3}>
      <Card title="Skills Library" icon="list-check" href="/skills">
        Browse all 10 public skills
      </Card>

      <Card title="Create Custom Skills" icon="sparkles" href="/skills/custom-skills">
        Build team-specific workflows
      </Card>

      <Card title="Workflow Examples" icon="diagram-project" href="/guides/workflows">
        Multi-product workflow patterns
      </Card>

      <Card title="API Keys Guide" icon="key" href="/api-keys">
        Manage scopes and security
      </Card>

      <Card title="Troubleshooting" icon="circle-question" href="/faq">
        Common issues and solutions
      </Card>
    </CardGroup>
  </Tab>
</Tabs>

## Need Help?

<CardGroup cols={3}>
  <Card title="Read the FAQ" icon="circle-question" href="/faq">
    Common questions answered
  </Card>

  <Card title="Contact Support" icon="headset" href="mailto:support@ulpi.io">
    Get help from our team
  </Card>

  <Card title="Join Discord" icon="discord" href="https://discord.gg/ulpi">
    Community support
  </Card>
</CardGroup>