Documentation notebook

Field guide for DocShark internals

Home / Docs / Getting Started

Getting Started

DocShark is installed with Bun and can be used as an MCP server across various AI clients.

Setup

Recommended install path

Use `bunx` for ad hoc runs. Switch to a global Bun install only if your team benefits from a shorter command name.

Installation

# Install globally (optional)
bun add -g docshark

# Or run on the fly
bunx docshark [command]
Works with standard clients

Claude Desktop, Cursor, and VS Code can all launch DocShark through command-based MCP config.

No daemon required

Run `docshark start --stdio` directly from the client command; no extra service management needed.

IDE & Desktop Integrations

Claude Desktop

Edit your claude_desktop_config.json:

  • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "docshark": {
      "command": "bunx",
      "args": ["-y", "docshark", "start", "--stdio"]
    }
  }
}

Cursor

  1. Go to Settings > Models > MCP
  2. Add a command-based server:
    • Name: docshark
    • Command: bunx -y docshark start --stdio

VS Code (Copilot)

Add to your workspace .vscode/settings.json or .vscode/mcp.json:

{
  "mcpServers": {
    "docshark": {
      "command": "bunx",
      "args": ["-y", "docshark", "start", "--stdio"]
    }
  }
}

Basic Usage

# Add a documentation site
bunx docshark add https://svelte.dev/docs

# List indexed libraries
bunx docshark list

# Search across all docs
bunx docshark search "component lifecycle"

# Search within a specific library
bunx docshark search "runes" --library svelte-dev

# Get a specific page
bunx docshark get svelte-dev /docs/svelte/overview

Available Tools

Once connected as an MCP server, DocShark exposes these tools to your AI assistant:

ToolActionParameters
manage_libraryAdd, rename, refresh, remove, inspectaction, url, name, version, max_depth, current_name, new_name, library
search_docsSearch indexed docsquery, library, limit
list_librariesList all indexed librariesstatus
get_doc_pageRead a specific pageurl, library, path

A local-first research notebook for software documentation. Crawl, index, and serve real docs to coding agents without adding a cloud layer to the workflow.

GitHub repository

Built for grounded documentation workflows and long-form technical reading.

© 2026 DocShark