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

# Sphinx plugin onboarding for Claude

> Install and connect the Sphinx plugin in Claude.ai, Claude Desktop, and Claude Code CLI.

Use this guide to make the Sphinx plugin available to your organization and connect it to Claude.ai, Claude Desktop, or Claude Code CLI.

<Note>
  Claude.ai, Claude Desktop, and Claude Code use similar interfaces, but their setup steps differ. Organization administrators should complete the organization setup first. Each user must then connect and authenticate Sphinx.
</Note>

## Organization administrator setup

After you complete this setup, members of your organization can access the Sphinx plugin and connector according to the access level you select. Each member must authenticate the Sphinx connector before using it.

### Prerequisites

Before you begin, make sure you have:

* Organization administrator access in Claude
* The `sphinx.zip` plugin file from Sphinx
* The Sphinx custom connector details

### Upload the Sphinx plugin

<Steps>
  <Step title="Open organization settings">
    Sign in to [Claude.ai](https://claude.ai), click your user icon in the bottom-left corner, and select **Organization settings**.
  </Step>

  <Step title="Open the Plugins page">
    Navigate to **Plugins**, then click **Add plugins** and select **Upload from file**.
  </Step>

  <Step title="Upload the plugin">
    Enter `Sphinx` as the marketplace name. Click the file icon, select `sphinx.zip`, and upload it.
  </Step>

  <Step title="Add the Sphinx connector">
    Add Sphinx as a custom connector using the connector details provided by Sphinx.
  </Step>

  <Step title="Set user access">
    Choose the access level for the Sphinx plugin:

    | Access level             | Behavior                                                               |
    | ------------------------ | ---------------------------------------------------------------------- |
    | **Available to install** | Users can choose whether to install the plugin.                        |
    | **Installed by default** | The plugin is installed for users by default.                          |
    | **Not available**        | The plugin is hidden from users but remains visible to administrators. |
    | **Required**             | The plugin is always installed and users cannot uninstall it.          |
  </Step>
</Steps>

<Info>
  The plugin becomes available in Claude.ai and Claude Desktop. Claude Code users working from the CLI must install the plugin manually. The connector is available in Claude.ai, Claude Desktop, and Claude Code, but users must authenticate it themselves for full functionality.
</Info>

## Connect Claude.ai or Claude Desktop

Complete these steps after your organization administrator has made the Sphinx plugin and connector available.

### Prerequisites

Before you begin, make sure you have:

* Access to an organization where the Sphinx plugin is available
* Access to a Sphinx workspace

<Steps>
  <Step title="Open settings">
    Click your user icon in the bottom-left corner, then select **Settings**.
  </Step>

  <Step title="Open Connectors">
    Navigate to **Connectors**.
  </Step>

  <Step title="Connect Sphinx">
    Find Sphinx and click **Connect**.
  </Step>

  <Step title="Authorize your workspace">
    Select the Sphinx workspace you want to use, then click **Connect**.
  </Step>
</Steps>

<Check>
  Sphinx is connected and available in Claude.ai or Claude Desktop.
</Check>

## Allow artifact uploads in Claude.ai

Add the Sphinx domain to Claude.ai so artifacts can upload files to Sphinx.

<Steps>
  <Step title="Open settings">
    Click your user icon in the bottom-left corner, then select **Settings**.
  </Step>

  <Step title="Open Capabilities">
    Navigate to **Capabilities** and scroll to the bottom of the page.
  </Step>

  <Step title="Allow the Sphinx domain">
    Under **Additional allowed domains**, add `*.sphinx.ai`.
  </Step>
</Steps>

## Install the plugin in Claude Code CLI

<Warning>
  Claude Code loads the plugin from the unzipped `sphinx.zip` folder. If you delete that folder, the Sphinx plugin will disappear from Claude Code. Keep the folder in a permanent location.
</Warning>

### Prerequisites

Before you begin, make sure you have:

* Claude Code installed
* The `sphinx.zip` plugin file from Sphinx
* Access to a Sphinx workspace

<Steps>
  <Step title="Extract the plugin">
    Download `sphinx.zip` and unzip it to a local folder.
  </Step>

  <Step title="Add the marketplace">
    In Claude Code, run `/plugin`. Navigate to **Marketplaces**, select **Add Marketplace**, paste the path to the unzipped plugin folder, and press **Enter**.
  </Step>

  <Step title="Install the Sphinx plugin">
    Open the **Discover** tab and install the Sphinx plugin.
  </Step>

  <Step title="Reload the plugin">
    Run `/reload-plugin`.
  </Step>

  <Step title="Open MCP settings">
    Run `/mcp`, then select the `Plugin:sphinx:sphinx` MCP server.

    <Note>
      If you already connected Sphinx in Claude.ai or Claude Desktop, you might see another Sphinx MCP server. Select the server named `Plugin:sphinx:sphinx` for the plugin installed from the local marketplace.
    </Note>
  </Step>

  <Step title="Authenticate Sphinx">
    Enable the MCP server and complete the authentication flow.
  </Step>
</Steps>

<Check>
  The Sphinx plugin and MCP server are enabled in Claude Code CLI.
</Check>

## Use an API key with Claude Code CLI

If you prefer API-key authentication, first complete the Claude Code CLI installation above. Then follow [API key setup for Claude Code CLI](../claude-code-cli/api-key-setup) to create a Sphinx API key and add it to `.mcp.json`.

<Warning>
  Treat your Sphinx API key as a secret. Do not commit `.mcp.json` if it contains the key, and do not share the key in logs or messages.
</Warning>