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

# Codex plugin

> Install the official Pinecone plugin for Codex to manage indexes, run vector search, and build RAG assistants from Codex using skills and MCP tools.

export const PrimarySecondaryCTA = ({primaryLabel, primaryHref, primaryTarget, secondaryLabel, secondaryHref, secondaryTarget}) => <div style={{
  display: 'flex',
  alignItems: 'center',
  gap: 16
}}>
   {primaryLabel && primaryHref && <div style={{
  width: 'fit-content',
  height: 42,
  background: 'var(--brand-blue)',
  borderRadius: 4,
  overflow: 'hidden',
  flexDirection: 'column',
  justifyContent: 'center',
  alignItems: 'center',
  display: 'inline-flex'
}}>
      <a href={primaryHref} target={primaryTarget} style={{
  paddingLeft: 22,
  paddingRight: 22,
  paddingTop: 8,
  paddingBottom: 8,
  justifyContent: 'center',
  alignItems: 'center',
  gap: 4,
  display: 'inline-flex',
  textDecoration: 'none',
  borderBottom: 'none'
}}>
        <div style={{
  textAlign: 'justify',
  color: 'var(--text-contrast)',
  fontSize: 15,
  fontWeight: '600',
  letterSpacing: 0.46,
  wordWrap: 'break-word'
}}>
          {primaryLabel}
        </div>
        <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" style={{
  marginLeft: 2
}}>
          <path d="M9.70492 6L8.29492 7.41L12.8749 12L8.29492 16.59L9.70492 18L15.7049 12L9.70492 6Z" fill="white" style={{
  fille: "var(--text-contrast)"
}} />
        </svg>
      </a>
    </div>}

    {secondaryLabel && secondaryHref && <div style={{
  width: 'fit-content',
  height: 42,
  borderRadius: 4,
  overflow: 'hidden',
  flexDirection: 'column',
  justifyContent: 'center',
  alignItems: 'center',
  display: 'inline-flex',
  textDecoration: 'none'
}}>
        <a href={secondaryHref} target={secondaryTarget} style={{
  paddingLeft: 11,
  paddingRight: 11,
  paddingTop: 8,
  paddingBottom: 8,
  justifyContent: 'center',
  alignItems: 'center',
  gap: 8,
  display: 'inline-flex',
  textDecoration: 'none',
  borderBottom: 'none'
}}>
          <div style={{
  textAlign: 'justify',
  color: 'var(--brand-blue)',
  fontSize: 15,
  fontWeight: '600',
  letterSpacing: 0.46,
  wordWrap: 'break-word'
}}>
            {secondaryLabel}
          </div>
        </a>
      </div>}

  </div>;

The official Pinecone plugin for [Codex](https://developers.openai.com/codex) adds Pinecone skills and the Pinecone MCP server to your Codex sessions. Use natural language to manage indexes, query data, build RAG applications, and create document Q\&A assistants, with up-to-date Pinecone API knowledge.

<PrimarySecondaryCTA primaryLabel={"View on GitHub"} primaryHref={"https://github.com/pinecone-io/pinecone-codex-plugin"} primaryTarget={"_blank"} />

## Features

* **Built-in skills** for index management, semantic search, full-text search, assistant creation, and more
* **Bundled MCP server** for direct Pinecone operations from Codex, with no extra setup
* **Natural language activation** — Codex invokes the right skill based on your conversation

## Prerequisites

* A [Pinecone API key](https://app.pinecone.io/organizations/-/keys)
* The [Codex](https://developers.openai.com/codex) desktop app or CLI installed. The plugin runs locally, so it doesn't work in Codex cloud tasks.
* [Node.js](https://nodejs.org/) installed and on your `PATH` (required for the bundled MCP server)
* [uv](https://docs.astral.sh/uv/getting-started/installation/) installed (required for the assistant and full-text search ingestion skills)
* [Pinecone CLI](/reference/cli/quickstart) installed (optional, enables the `pinecone:cli` skill)

## Install the plugin

Install the plugin from the Codex plugin directory or the command line, then set your API key and launch Codex.

<Steps>
  <Step title="Add the plugin to Codex">
    <Tabs>
      <Tab title="Plugin directory">
        1. In the Codex app, select **Plugins** in the sidebar.
        2. Find **Pinecone** and select it.
        3. Select **Install plugin**.

        For more about installing plugins, see [Plugins in ChatGPT](https://help.openai.com/en/articles/20001256-plugins-in-chatgpt) in the OpenAI Help Center.
      </Tab>

      <Tab title="Command line">
        1. Add the Pinecone marketplace:

           ```shell theme={null}
           codex plugin marketplace add pinecone-io/pinecone-codex-plugin
           ```

        2. Install the plugin:

           ```shell theme={null}
           codex plugin add pinecone --marketplace pinecone-codex-plugins
           ```

        3. Confirm the plugin is installed:

           ```shell theme={null}
           codex plugin list | grep pinecone
           ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Set your API key and launch Codex">
    Installing the plugin doesn't set your API key. Codex reads it from the environment it launches in.

    <Tabs>
      <Tab title="Codex CLI">
        Export the key in the same shell where you run `codex`:

        ```shell theme={null}
        export PINECONE_API_KEY="YOUR_API_KEY"
        codex
        ```

        Replace `YOUR_API_KEY` with your [Pinecone API key](https://app.pinecone.io/organizations/-/keys). To keep the key across terminal sessions, add the `export` line to your shell profile, such as `~/.zshrc`.
      </Tab>

      <Tab title="Codex desktop app (macOS)">
        Quit Codex, then export the key and relaunch Codex from the same terminal:

        ```shell theme={null}
        osascript -e 'quit app "Codex"'
        export PINECONE_API_KEY="YOUR_API_KEY"
        open -a Codex
        ```

        Replace `YOUR_API_KEY` with your [Pinecone API key](https://app.pinecone.io/organizations/-/keys).

        To make the key available when you open Codex from the Dock or Spotlight, set it for all macOS apps instead, then quit and reopen Codex:

        ```shell theme={null}
        launchctl setenv PINECONE_API_KEY "YOUR_API_KEY"
        ```

        This setting doesn't persist after you restart your Mac, so run it again after each restart.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Run the quickstart">
    In a new Codex session, ask:

    ```text theme={null}
    Use Pinecone's quickstart to create an index, add sample data, and run my first search.
    ```

    Codex invokes the `pinecone:quickstart` skill, checks the connection to the Pinecone MCP server, creates an integrated index, upserts sample records, and runs a search.
  </Step>
</Steps>

## Available skills

Codex picks the right skill based on what you ask. To call a skill directly, type `$` followed by its name, such as `$pinecone:quickstart`. To bring in the whole plugin, mention `@pinecone`.

| Skill | Description |
| - | - |
| `pinecone:help` | Overview of all skills and setup requirements. Start here. |
| `pinecone:quickstart` | Walks you through creating an index, upserting data, and running a query. |
| `pinecone:query` | Search integrated indexes using natural language via the Pinecone MCP server. |
| `pinecone:assistant` | Create, upload, sync, and chat with Pinecone Assistants for document Q\&A with citations. |
| `pinecone:cli` | Guide for using the Pinecone CLI (`pc`) from the terminal. |
| `pinecone:full-text-search` | Create, ingest into, and query a Pinecone full-text-search (FTS) index. Requires Python SDK v10.0.0 or later. |
| `pinecone:n8n` | Build [n8n](/integrations/n8n) workflows with the Pinecone Assistant node or Pinecone Vector Store, including best practices and full workflow JSON generation. |
| `pinecone:mcp` | Reference for all Pinecone MCP server tools. |
| `pinecone:docs` | Curated links to official Pinecone documentation. |

## MCP tools

The plugin includes the Pinecone MCP server, which provides the following tools:

* `search-docs`: Search the official Pinecone documentation.
* `list-indexes`: List all available Pinecone indexes.
* `describe-index`: Get index configuration and namespaces.
* `describe-index-stats`: Get record counts and namespace statistics.
* `create-index-for-model`: Create a new index with integrated embeddings.
* `upsert-records`: Insert or update records in an index.
* `search-records`: Search records with optional metadata filtering and reranking.
* `cascading-search`: Search across multiple indexes with deduplication and reranking.
* `rerank-documents`: Rerank documents using a specified reranking model.

For full MCP server documentation, see [Use the Pinecone MCP server](/guides/operations/mcp-server).

## Troubleshooting

<AccordionGroup>
  <Accordion title="API key not found or 401 errors">
    * **Codex desktop app (macOS):** Run `launchctl getenv PINECONE_API_KEY`. If it returns nothing, set the key again and quit and reopen Codex.
    * **Codex CLI:** In the same shell where you run `codex`, run `[ -n "$PINECONE_API_KEY" ] && echo "set" || echo "not set"`. If it prints `not set`, export the key again.
  </Accordion>

  <Accordion title="MCP server not responding">
    Make sure Node.js is on your `PATH` and your API key is valid, then restart Codex.
  </Accordion>

  <Accordion title="The query skill returns no results">
    The `pinecone:query` skill works only with integrated indexes, which use a Pinecone-hosted embedding model. For indexes that use external embeddings, use the `pinecone:cli` skill or the MCP tools directly.
  </Accordion>

  <Accordion title="Assistant or full-text search skill errors">
    Run `uv --version` to confirm `uv` is installed. If it's missing, install it and restart your terminal.
  </Accordion>
</AccordionGroup>

## Resources

* [GitHub repository](https://github.com/pinecone-io/pinecone-codex-plugin)
* [Codex documentation](https://developers.openai.com/codex)
* [Plugins in ChatGPT (OpenAI Help Center)](https://help.openai.com/en/articles/20001256-plugins-in-chatgpt)
* [Pinecone MCP server guide](/guides/operations/mcp-server)