Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (askbudi-context) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AskBudi Context MCP Server

Get up-to-date documentation for any GitHub repository directly in your AI coding assistant

Website • Documentation • Support

❌ Without AskBudi Context

AI assistants rely on outdated training data
Documentation searches require manual copy-pasting
Library updates and new features are missed
Inconsistent or hallucinated code examples
Time wasted on deprecated methods and patterns

✅ With AskBudi Context

Real-time access to ANY public GitHub repository
Always up-to-date documentation and examples
Contextual answers based on your specific questions
Reduced hallucinations with accurate, current information
Seamless integration with your favorite AI coding tools

🚀 Quick Start

Requirements

Node.js 18+ installed on your system
An AskBudi API key (Get yours free)

Installation

Choose your preferred AI coding tool:

📦 Installation Guides

🔥 Claude Code

Local Server Connection

Add to your Claude Code MCP settings (~/.claude_code_config.json):

{
  "mcpServers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "claude"
      }
    }
  }
}

🖥️ Claude Desktop

Local Server Connection

Add to your Claude Desktop config file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "claude-desktop"
      }
    }
  }
}

💻 Cursor

Local Server Connection

Add to your Cursor settings (Settings > Extensions > MCP):

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "cursor"
        }
      }
    }
  }
}

🌊 Windsurf

Local Server Connection

Add to your Windsurf settings.json:

{
  "mcp.servers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "windsurf"
      }
    }
  }
}

🎯 Trae

Local Server Connection

Add to your Trae configuration:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "trae"
        }
      }
    }
  }
}

🎨 VS Code

Local Server Connection

For VS Code with MCP-compatible extensions (like Continue, Cline):

Method 1: Via settings.json

{
  "mcp.servers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "vscode"
      }
    }
  }
}

Method 2: Extension-specific config Check your specific extension's documentation for MCP server configuration.

🏢 Visual Studio 2022

Local Server Connection

Add to your Visual Studio MCP configuration:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "visual-studio"
        }
      }
    }
  }
}

⚡ Zed

Local Server Connection

Add to your Zed settings (~/.config/zed/settings.json):

{
  "assistant": {
    "mcp_servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "zed"
        }
      }
    }
  }
}

🔮 Cline (VS Code Extension)

Local Server Connection

Configure in Cline extension settings:

{
  "cline.mcp.servers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "cline"
      }
    }
  }
}

⚡ BoltAI

Local Server Connection

Add to BoltAI MCP configuration:

{
  "mcp_servers": {
    "askbudi": {
      "command": "npx",
      "args": ["-y", "askbudi-context@latest"],
      "env": {
        "ASKBUDI_API_KEY": "your-api-key-here",
        "PLATFORM": "boltai"
      }
    }
  }
}

🚀 Augment Code

Local Server Connection

Configure in Augment Code settings:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "augment"
        }
      }
    }
  }
}

🦘 Roo Code

Local Server Connection

Add to Roo Code configuration:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "roo"
        }
      }
    }
  }
}

💎 Gemini CLI

Local Server Connection

Configure MCP server for Gemini CLI:

# Set environment variables
export ASKBUDI_API_KEY="your-api-key-here"
export PLATFORM="gemini-cli"

# Add to Gemini CLI config
gemini config set mcp.servers.askbudi.command "npx"
gemini config set mcp.servers.askbudi.args '[-y, askbudi-context@latest]'

🐳 Docker

Local Server Connection

Run AskBudi Context in a Docker container:

docker run -it --rm \
  -e ASKBUDI_API_KEY="your-api-key-here" \
  -e PLATFORM="docker" \
  -p 3000:3000 \
  node:18-alpine \
  sh -c "npx -y askbudi-context@latest"

🖥️ Command Line Usage

Direct execution:

# Set your environment variables
export ASKBUDI_API_KEY="your-api-key-here"
export PLATFORM="cli"

# Run the server
npx -y askbudi-context@latest

🪟 Windows-Specific Setup

PowerShell:

# Set environment variables
$env:ASKBUDI_API_KEY="your-api-key-here"
$env:PLATFORM="windows"

# Run the server
npx -y askbudi-context@latest

Command Prompt:

rem Set environment variables
set ASKBUDI_API_KEY=your-api-key-here
set PLATFORM=windows

rem Run the server
npx -y askbudi-context@latest

🎯 Zencoder

Local Server Connection

Configure Zencoder to use the AskBudi MCP server:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "zencoder"
        }
      }
    }
  }
}

🚀 Amazon Q Developer CLI

Local Server Connection

Configure Amazon Q Developer CLI to use AskBudi:

# Set environment variables
export ASKBUDI_API_KEY="your-api-key-here"
export PLATFORM="amazon-q"

# Add to Amazon Q CLI config
q config set mcp.servers.askbudi.command "npx"
q config set mcp.servers.askbudi.args '[-y, askbudi-context@latest]'

🔧 Qodo Gen

Local Server Connection

Configure Qodo Gen to use the AskBudi MCP server:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "qodo-gen"
        }
      }
    }
  }
}

🧠 JetBrains AI Assistant

Local Server Connection

Configure JetBrains AI Assistant (IntelliJ IDEA, PyCharm, etc.):

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "jetbrains"
        }
      }
    }
  }
}

🌊 Warp

Local Server Connection

Configure Warp terminal to use AskBudi:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "warp"
        }
      }
    }
  }
}

📝 Opencode

Local Server Connection

Configure Opencode to use the AskBudi MCP server:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "opencode"
        }
      }
    }
  }
}

🤖 Copilot Coding Agent

Local Server Connection

Configure GitHub Copilot Coding Agent:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "copilot-agent"
        }
      }
    }
  }
}

🎮 Kiro

Local Server Connection

Configure Kiro to use the AskBudi MCP server:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "kiro"
        }
      }
    }
  }
}

🔮 OpenAI Codex

Local Server Connection

Configure OpenAI Codex integration:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "openai-codex"
        }
      }
    }
  }
}

🎭 LM Studio

Local Server Connection

Configure LM Studio to use AskBudi:

{
  "mcp": {
    "servers": {
      "askbudi": {
        "command": "npx",
        "args": ["-y", "askbudi-context@latest"],
        "env": {
          "ASKBUDI_API_KEY": "your-api-key-here",
          "PLATFORM": "lm-studio"
        }
      }
    }
  }
}

🛠️ Available Tools

AskBudi Context provides three powerful tools for your AI assistant:

`resolve_library_id`

Search for any GitHub repository to get its library ID.

Parameters:

search_term (string): Repository name, organization, or keywords
limit (number, optional): Max results (1-50, default: 10)

Example usage:

Find me the React repository

`get_library_docs`

Get up-to-date documentation and code examples from any repository.

Parameters:

library_id (string): The library identifier from resolve_library_id
prompt (string): Your specific question or use case
version (string, optional): Specific version/branch (default: latest)
limit (number, optional): Max snippets (1-20, default: 5)

Example usage:

How do I create a custom hook in React with TypeScript?
Show me FastAPI middleware examples
What are the new features in Next.js 15?

`get_crawl_queue_status`

Check the status of documentation crawling for repositories.

Parameters:

include_details (boolean, optional): Include detailed info (default: true)

💡 Tips

Getting Better Results

Be specific in your questions:
- ❌ "How to use React?"
- ✅ "How to create a custom hook in React with useState and useEffect?"
Mention the library name when asking questions:
- ❌ "How to create middleware?"
- ✅ "How to create middleware in FastAPI?"
Ask about specific versions when needed:
- "Show me async/await patterns in Node.js 20"
- "What's new in Python 3.12?"

Supported Repository Types

✅ All public GitHub repositories
✅ Documentation sites (if linked from GitHub)
✅ README files and wikis
✅ Code examples and tests
✅ Release notes and changelogs

🔧 Environment Variables

Variable	Required	Default	Description
`ASKBUDI_API_KEY`	Yes	-	Your AskBudi API key
`PLATFORM`	No	"unknown"	Editor/platform name (cursor, claude, windsurf, etc.)
`ASKBUDI_BACKEND_URL`	No	Production URL	Custom backend URL
`DEBUG`	No	false	Enable debug logging
`TIMEOUT`	No	30000	Request timeout in milliseconds

🐛 Troubleshooting

Server Won't Start

Problem: "Package not found" error

npm install -g npm@latest
npx clear-npx-cache

Problem: Permission denied

# Use npx instead of global installation - no permissions needed!
npx -y askbudi-context@latest

API Key Issues

Problem: "Invalid API key" error

Verify your API key is correct: echo $ASKBUDI_API_KEY
Get a new key at askbudi.ai/dashboard/api-keys
Make sure there are no extra spaces or quotes

No Documentation Found

Problem: Repository not found or no results

Try different search terms for the repository
Check if the repository is public on GitHub
Some repositories may still be processing - try again later

🔗 Links

Website: askbudi.ai
Documentation: askbudi.ai/docs
Get API Key: askbudi.ai/auth/signup
Support: support@askbudi.ai
GitHub: github.com/askbudi

📄 License

MIT License - see LICENSE for details.

Made with ❤️ by the AskBudi team