ContextMCP/ContextMCP

Quick Start

Get ContextMCP running in 5 minutes

Prerequisites

  • Node.js 18+
  • OpenAI API key
  • Pinecone account + API key

1. Initialize

npx contextmcp init
cd your-project-name

2. Configure

cp config.example.yaml config.yaml
cp .env.example .env

Edit .env with your keys:

OPENAI_API_KEY=sk-...
PINECONE_API_KEY=...
GITHUB_TOKEN=ghp_...  # Optional: for private repos

Edit config.yaml to point to your docs:

vectordb:
  provider: pinecone
  indexName: my-docs
  pinecone:
    cloud: aws
    region: us-east-1

embeddings:
  provider: openai
  model: text-embedding-3-large
  dimensions: 3072

sources:
  - name: docs
    type: github
    repository: your-org/your-repo
    path: docs/
    parser: mdx

See Configuration for all options.

3. Index

npm run reindex

4. Deploy

cd cloudflare-worker
wrangler secret put OPENAI_API_KEY
wrangler secret put PINECONE_API_KEY
npm run deploy

Your server is live at https://contextmcp.your-subdomain.workers.dev

See Deployment for GitHub Actions auto-reindex.

5. Connect Your Editor

Cursor

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "my-docs": {
      "url": "https://your-worker.workers.dev/mcp"
    }
  }
}

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "my-docs": {
      "serverUrl": "https://your-worker.workers.dev/mcp"
    }
  }
}

Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote@latest", "https://your-worker.workers.dev/mcp"]
    }
  }
}

Restart your editor. Done!

Test It

# Health check
curl https://your-worker.workers.dev/health

# Search
curl "https://your-worker.workers.dev/search?query=authentication"

Next Steps