unlob Docs
Browse documentation

path: connect two passages

Coverage Graph: the shortest chain of edges linking two passages — connect-the-dots retrieval.

Behaviour

Returns the node chain between them: passages (p:), hosts (h:), stories (s:), topics (t:), entities (e:). `found: false` means no chain exists within the corpus, which is itself an answer — these two things are not connected in anything we hold.

Costs 2 credits; a call that runs and fails costs 1.

Arguments

inputSchema

NameTypeDescription
arequiredstringStart passage id. `from` is accepted as an alias.
brequiredstringGoal passage id. `to` is accepted as an alias.

Returns

A JSON payload in the text content block, and the same payload as structuredContent for clients that support it.

outputSchema

NameType
foundrequiredboolean
hopsrequiredinteger
nodesrequiredobject[]

Calling it

Over Streamable HTTP, with the required arguments filled in:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "path",
    "arguments": {
      "a": "<a>",
      "b": "<b>"
    }
  }
}

Most clients do this for you — see Connect a client. To drive it by hand, complete the startup lifecycle first.

The same call over REST

If your client does not speak MCP, this capability is GET /path, taking the same parameters and returning the same body.

curl -H "x-api-key: $UNLOB_API_KEY" \
  "https://api.unlob.com/path?a=<a>&b=<b>"