Skip to content

Commit b286fc6

Browse files
committed
Instruct to ask how to handle index creation
1 parent abaa0e2 commit b286fc6

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.agents/PINECONE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,34 @@ Based on what the user is asking, consult these guides:
104104
-**Other services** - explicit embeddings generation, reranking, etc.
105105
-**Unit and integration tests**
106106

107+
### 🎯 MANDATORY: Index Creation - Choose Your Approach
108+
109+
**⚠️ CRITICAL: When a user needs to create a Pinecone index, you MUST:**
110+
111+
1. **Explain all four options** (see below)
112+
2. **Ask the user which method they prefer**
113+
3. **Assist them accordingly** with instructions, code, or executing commands
114+
115+
**Never assume a method or proceed without the user's choice.**
116+
117+
#### Index Creation Options
118+
119+
There are four ways to create a Pinecone index:
120+
121+
1. **Manual via Web Console** - [https://app.pinecone.io/](https://app.pinecone.io/) - Best for one-time setup, learning. Agent provides instructions on settings (metric, cloud, region, embedding model).
122+
123+
2. **Using Pinecone CLI** - `pc index create` command (see [PINECONE-cli.md](./PINECONE-cli.md)). Best for quick setup, CI/CD, automation. Agent provides/executes CLI command.
124+
125+
3. **Dedicated Setup Script** - Standalone script (e.g., `setup.sh`, `init.py`, `scripts/setup.ts`) using SDK. Best for explicit initialization steps. Agent creates script with idempotent index creation (check if exists before creating).
126+
127+
4. **Auto-create in App Initialization** - Add index creation/verification to app startup code. Best for production, automated deployments. Agent adds idempotent logic to initialization functions.
128+
129+
**For SDK implementation details**, see language-specific guides: [PINECONE-python.md](./PINECONE-python.md), [PINECONE-typescript.md](./PINECONE-typescript.md), [PINECONE-go.md](./PINECONE-go.md), [PINECONE-java.md](./PINECONE-java.md).
130+
131+
**After creation**, verify with `pc index list` or `pc index describe --name <index-name>`.
132+
133+
**Important**: Help user choose descriptive index name, ensure proper configuration (metric, cloud, region, embedding model), implement idempotency for options 3-4, handle errors gracefully.
134+
107135
## CLI Setup and Usage
108136

109137
For detailed CLI installation, authentication, and command reference, see [PINECONE-cli.md](./PINECONE-cli.md).

0 commit comments

Comments
 (0)