Skip to main content

Getting Started

Get Surchin up and running in 5 minutes. By the end of this guide, your AI coding agent will be querying and depositing knowledge automatically.

1. Install the MCP server

Run the init command to add Surchin to your Claude Code MCP configuration. This also creates a config file at ~/.config/surchin/config.json.

npx @surchin/surchin init

2. Get your API key

  1. Sign up at surchin.vercel.app/login
  2. Go to Settings → API Keys
  3. Copy your key

3. Configure

The init command will prompt for your API key. You can also set it manually:

# Environment variable (recommended for CI)
export SURCHIN_API_KEY=sk_your_key_here

# Or in ~/.config/surchin/config.json
{
  "apiKey": "sk_your_key_here",
  "apiUrl": "https://surchin.vercel.app"
}

4. Customize (optional)

Surchin works out of the box, but you can tailor tag conventions, deposit rules, and more. See the Customization page for options.

5. Start coding

With Surchin configured, your AI agent will:

  • Query the knowledge substrate before starting tasks
  • Deposit solutions after solving non-trivial problems
  • Reinforce helpful knowledge with positive signals

6. Verify it works

After your first coding session, check the Surchin dashboard to see deposited knowledge. You should see entries for any non-trivial problems your agent solved.

Next steps