pinecone-mcp
v1.0.0
Published
MCP server for interacting with Pinecone vector database
Maintainers
Readme
Pinecone MCP Server
An MCP (Model Context Protocol) server for interacting with Pinecone vector database. This server provides tools for AI agents to interact with Pinecone databases through natural language.
Prerequisites
This project requires the MCP TypeScript SDK. Until it's publicly available on npm, you'll need to:
- Download the latest release of the SDK (file named like
modelcontextprotocol-sdk-0.1.0.tgz) - Install it manually:
npm install --save path/to/modelcontextprotocol-sdk-0.1.0.tgzFeatures
- List all Pinecone indexes
- Describe specific indexes
- Query vectors with customizable parameters
- Support for namespaces and filters
- Easy integration with AI agents
Installation
You can install and run this package directly using npx:
npx pinecone-mcpOr install it globally:
npm install -g pinecone-mcp
pinecone-mcpYou can also install it from GitHub:
npx github:YOUR_USERNAME/pinecone-mcpConfiguration
Before running the server, you need to set up your Pinecone API key.
- Copy the example environment file:
cp .env.example .env- Edit the
.envfile and replaceyour_api_key_herewith your actual Pinecone API key from the Pinecone dashboard.
Available Tools
listIndexes
Lists all available Pinecone indexes in your account.
Example:
Use the listIndexes tooldescribeIndex
Get detailed information about a specific index.
Example:
Use the describeIndex tool with indexName = "my-index"queryVectors
Query vectors in an index with various parameters.
Example:
Use the queryVectors tool with:
- indexName = "my-index"
- queryVector = [0.1, 0.2, 0.3]
- topK = 5
- namespace = "my-namespace" (optional)describeIndexStats
Get statistical information about a specific index.
Example:
Use the describeIndexStats tool with:
- indexName = "my-index"fetchVectors
Fetch specific vectors by their IDs from an index.
Example:
Use the fetchVectors tool with:
- indexName = "my-index"
- ids = ["vector-id-1", "vector-id-2"]
- namespace = "my-namespace" (optional)listCollections
List all collections in your Pinecone account.
Example:
Use the listCollections tooldescribeCollection
Get detailed information about a specific collection.
Example:
Use the describeCollection tool with:
- collectionName = "my-collection"Development
To build the project:
npm run buildTo run in development mode:
npm run devLicense
MIT
