Connect source

POST/api/v1/connect_source

Features

Connect a repository, a website or a single page as a SOURCE OF TRUTH for this documentation — what list_sources then lists and read_source reads, and what an agent armed with enable_agent watches. A GitHub repository is PROVED readable before anything is stored — publicly, or with a GitHub authorisation this project already holds — so this never leaves behind a source that quietly reads nothing. A private repository nobody has authorised yet comes back as REPO_UNREADABLE with the one thing that fixes it (the owner grants repository access once, in their panel); connect it anyway is not an option this tool offers. note is the owner's own words about why the source is connected and is read as instruction by everything that later reads it — say what it is for ('the API server the reference pages describe'), not what it is.

Price — $0.00003 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/connect_source.

Input3

Authorizationheaderrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.

urlstring · body

The address to connect: 'https://github.com/acme/api', 'https://acme.com', or one page of it.

notestring · body

What this source is for, in the owner's words — read as instruction by every tool that later reads the source.

labelstring · body

What to call it in the list. Defaults to the repository or host name.

Output3

okboolean

Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers 200 with ok: false: the call was made and billed, and that refusal is its answer.

resultobject

The tool's own JSON answer, already parsed — not a string to parse a second time.

Show child attributes5

sourceobject

{ id, kind, label, url, note, status, is_private, has_authorization }.

verifiedobject

What was checked before storing it.

authorizationstring

null

head_commitobject

hintstring

duration_msinteger

Server-side wall time for the call.

Use cases

Use it when the docs are about a product whose code or site this project cannot currently read: connecting the repository is what turns 'the docs claim X' into something checkable.

Limitations

REQUIRES a read-write MCP token.

Responses

200The tool ran. Read ok to see whether it succeeded.

401Missing or invalid API key.

Example input

curl -X POST 'https://docsbook.io/api/v1/connect_source' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example output

{
  "ok": true,
  "result": {
    "source": {},
    "verified": {},
    "authorization": "<authorization>",
    "head_commit": {},
    "hint": "<hint>"
  },
  "duration_ms": 0
}

Atualizado Sep 24, 2026