Skip to content

Usage examples documentation#47

Draft
jhamon wants to merge 3 commits intomainfrom
cursor/SDK-318-usage-examples-documentation-8e2f
Draft

Usage examples documentation#47
jhamon wants to merge 3 commits intomainfrom
cursor/SDK-318-usage-examples-documentation-8e2f

Conversation

@jhamon
Copy link
Copy Markdown
Contributor

@jhamon jhamon commented Feb 3, 2026

Overview

Adds comprehensive usage examples and tutorials documentation for the Pinecone MCP server to improve user onboarding and reduce support burden. This includes a new examples/ directory with quickstart, advanced, and integration tutorials, and an updated README.md with links to these examples and an expanded troubleshooting section.

Link to issue

SDK-318

Type

  • Bug fix
  • New feature
  • Improvement
  • Infrastructure change
  • Documentation

Linear Issue: SDK-318

Open in Cursor Open in Web

- Create examples directory with quickstart, advanced, and integrations sections
- Add quickstart tutorials: create-index, upsert-search, reranking
- Add advanced tutorials: cascading-search, analytics-tracking, error-handling
- Add integration workflows: cursor-workflow, claude-desktop-workflow, gemini-cli-workflow
- Update README with Examples section linking to all tutorials
- Expand Troubleshooting section with detailed solutions for common issues
- Each tutorial includes step-by-step instructions, real-world examples, and troubleshooting tips

Resolves SDK-318

Co-authored-by: jhamon <jhamon@pinecone.io>
@cursor
Copy link
Copy Markdown

cursor Bot commented Feb 3, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

cursoragent and others added 2 commits February 3, 2026 06:13
- Delete examples/advanced/analytics-tracking.md (not accurate for public use)
- Create TROUBLESHOOTING.md with detailed troubleshooting guidance
- Simplify README troubleshooting section to basic info with link to detailed guide
- Remove all references to analytics-tracking from other tutorial files
- Reduce emphasis on errors in main README

Co-authored-by: jhamon <jhamon@pinecone.io>
…ent AI agents

- Move integration workflow guides to top as 'Getting Started' section
- Add clear visual distinction with emojis for Cursor, Claude Desktop, and Gemini CLI
- Simplify Quick Setup section with brief config examples and links to full guides
- Rename 'Examples' to 'Learn More' and position after Usage section
- Add reference in Usage section to integration guides for complete workflows
- Remove redundant docs link from intro (keeping focus on integration guides)

Co-authored-by: jhamon <jhamon@pinecone.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants