Skip to content

Commit cfddc0c

Browse files
committed
Make AGENTS.md snippet more explicit and actionable.
1 parent 2bc25c8 commit cfddc0c

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

AGENTS-pinecone-snippet.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
## Pinecone (Vector Database)
22

3-
**Main documentation**: [`.agents/PINECONE.md`](.agents/PINECONE.md) - Universal concepts, CLI vs SDK guidance, common patterns, and navigation guide
3+
**CRITICAL**: When users ask about Pinecone, vector databases, embeddings, semantic search, RAG, or recommendations, you MUST:
44

5-
**Additional resources**:
5+
1. **ALWAYS read** `.agents/PINECONE.md` first - this contains universal concepts, CLI vs SDK guidance, common patterns, and navigation instructions
6+
2. **THEN read** the appropriate language-specific guide based on the user's project:
7+
- `.agents/PINECONE-python.md` - Python SDK guide with code examples
8+
- `.agents/PINECONE-typescript.md` - TypeScript/Node.js SDK guide with code examples
9+
- `.agents/PINECONE-go.md` - Go SDK guide with code examples
10+
- `.agents/PINECONE-java.md` - Java SDK guide with code examples
11+
3. **For quickstart/tutorials**: Read `.agents/PINECONE-quickstart.md` for step-by-step tutorials
12+
4. **For CLI operations**: Read `.agents/PINECONE-cli.md` for CLI installation, authentication, and commands
613

7-
- `.agents/PINECONE-quickstart.md` - Step-by-step tutorials (Quick Test, Search, RAG, Recommendations)
8-
- `.agents/PINECONE-cli.md` - CLI installation, authentication, and command reference
9-
- `.agents/PINECONE-python.md` - Python SDK guide with code examples
10-
- `.agents/PINECONE-typescript.md` - TypeScript/Node.js SDK guide with code examples
11-
- `.agents/PINECONE-go.md` - Go SDK guide with code examples
12-
- `.agents/PINECONE-java.md` - Java SDK guide with code examples
14+
**Language Detection**: Check for `package.json` (TypeScript), `requirements.txt`/`pyproject.toml` (Python), `pom.xml`/`build.gradle` (Java), or `go.mod` (Go) to determine the appropriate guide.
1315

14-
**When users ask about Pinecone**: Start with `.agents/PINECONE.md` and use the "Choosing the Right Guide" section to navigate to the appropriate file.
16+
**DO NOT** provide Pinecone guidance without reading these files first. The `.agents/PINECONE.md` file contains critical gotchas, best practices, and common mistakes that must be followed.

0 commit comments

Comments
 (0)