Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,33 @@ url: "https://docs.example.com/getting-started"
---
```

## MCP Server

webpull ships an MCP server so any MCP-compatible agent (Claude Code, Cursor, Windsurf, etc.) can pull and search docs without leaving the chat.

**Register with Claude Code:**

```bash
claude mcp add webpull bun -- run /path/to/webpull/mcp/index.ts
```

**Or via `~/.claude/claude_desktop_config.json`:**

```json
{
"mcpServers": {
"webpull": {
"command": "bunx",
"args": ["webpull-mcp"]
}
}
}
```

**Available tools:** `pull_docs`, `search_docs`, `read_doc`, `list_docs`, `run_code`

See [`mcp/README.md`](mcp/README.md) for full details.

## Requirements

- [Bun](https://bun.sh) runtime
Expand Down
57 changes: 57 additions & 0 deletions mcp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# webpull-mcp

MCP server that exposes [webpull](https://github.com/Dhravya/webpull) to any MCP-compatible coding agent (Claude Code, Cursor, Windsurf, etc.).

## Prerequisites

```bash
bun install -g webpull
```

## Register with Claude Code

```bash
claude mcp add webpull bun -- run /path/to/webpull/mcp/index.ts
```

Or via `~/.claude/claude_desktop_config.json`:

```json
{
"mcpServers": {
"webpull": {
"command": "bun",
"args": ["run", "/path/to/webpull/mcp/index.ts"]
}
}
}
```

## Register with Cursor / other MCP clients

```json
{
"mcpServers": {
"webpull": {
"command": "bunx",
"args": ["webpull-mcp"]
}
}
}
```

## Tools

| Tool | Description |
|------|-------------|
| `pull_docs` | Crawl any public docs site and save as local markdown |
| `search_docs` | Full-text search across locally pulled docs |
| `read_doc` | Read a specific markdown file (capped at 50k chars) |
| `list_docs` | List all pulled sites or files within a site |
| `run_code` | Execute JS/TS/Python/Bash snippets in a subprocess |

## Configuration

| Env var | Default | Description |
|---------|---------|-------------|
| `WEBPULL_DOCS_DIR` | `~/.webpull-docs` | Root directory for saved docs |
Loading