Aperçu

Configure source

POST/api/v1/configure_source
Features

Change or disconnect one of this project's connected sources (see list_sources): rename it, rewrite the note every tool reads as instruction, pause it, or remove it. Pausing (enabled: false) keeps the row and stops every tool and agent from reading it — the move for a repository that has moved or a site that is being rebuilt. disconnect: true deletes it, along with any GitHub authorisation attached to it. Identify the source by source_id from list_sources, or by match (a word from its label or URL).

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/configure_source.

Input6
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.
source_idnumber · body
The source's id from list_sources.
matchstring · body
Part of its label or URL, when you do not have the id (e.g. 'acme/api').
notestring · body
Replace what this source is for. Read as instruction by everything that reads the source.
labelstring · body
Rename it in the list.
enabledboolean · body
false pauses the source: it stays connected and nothing reads it.
disconnectboolean · body
true removes the source entirely, with any GitHub authorisation attached to it.
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 attributes3
sourceobject
{ id, kind, label, url, note, status, is_private, has_authorization } — absent when disconnect: true was passed.
disconnectedobject
{ id, label, url } — present only on disconnect.
notestring
duration_msinteger
Server-side wall time for the call.
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/configure_source' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example output
{
  "ok": true,
  "result": {
    "source": {},
    "disconnected": {},
    "note": "<note>"
  },
  "duration_ms": 0
}

Mis à jour

Cette page vous a-t-elle été utile ?