@hy-sde-org/dsh-logseq-graph

@hy-sde-org/dsh-logseq-graph

English | 中文

Summary

ctx.wikiGraph exposes the Logseq CLI's db-worker-node graph operations as structured JSON calls, independent of any agent tools: page and block trees, tags, properties, Datalog queries, upserts and removals, and the logseq_server lifecycle. The web GUI's wiki drawer serves its reads and writes through this service in the upstream harness, while the model-facing logseq_* tools (see @hy-sde-org/dsh-tool-logseq) call the same CLI directly. Choose it when a composition needs wiki-graph storage behind a host service with one logical change per call. The cost is one fresh CLI process per method call, and graph writes require a running db-worker-node server; the invariant companion fails fast at boot when the CLI binary is unreachable.

Table of Contents

• Service surface
• Model Experience
• Known Limitations and Deferred Work
• Dev Note

---

Host-plane graph service exposing the Logseq CLI's db-worker-node graph operations as structured JSON calls, independent of any agent tools: page/block trees, tags, properties, Datalog queries, upserts/removals, and the logseq_server lifecycle. In the upstream harness, the web GUI's embedded wiki drawer serves its reads/writes through this service via the apiproxy wiki domain; this standalone ships the service only (the drawer and its host API proxy row are not included). The model-facing logseq_* CLI tools (see @hy-sde-org/dsh-tool-logseq) use the same CLI directly.

Service surface

One Cordis service ctx.wikiGraph (LogseqGraphService) with methods:

• listPages({ includeBuiltIn, limit, offset }) → flat page rows
• getPage({ page | id | uuid }) → nested block tree + linked references
• listTags, listProperties
• search({ type, content, limit }), query({ query, inputs, limit }) (Datalog)
• upsert(args), remove(args) — one logical change per call, forwarded flag-for-flag
• server(action, { name }) — list / start / stop / restart / cleanup

Every method spawns the logseq CLI once (--graph when configured) with --output json, validates the envelope, and projects the raw rows into the wire view types (WikiTagRef, WikiBlockNode, WikiPageRoot, …). The @hy-sde-org/dsh-logseq-graph/invariant companion fails fast at boot when the CLI binary is unreachable.

Model Experience

None, as the host service registers no tool schema, prompt section, or result of its own; the wiki content it serves reaches the model only through @hy-sde-org/dsh-tool-logseq and the human's wiki drawer.

KV Cache effect

No prompt-shaping data comes from this package.

Known Limitations and Deferred Work

• • CLI must be installed — the service spawns logseq; there is no bundled binary (built from the logseq repo: opam exec -- dune build @bundle). The invariant companion gives an install hint and cliPath supports a non-PATH binary.
• • Per-call process spawn — each method starts a fresh CLI process. Fine for interactive drawer use and one-shot agent edits; a high-frequency integration should batch via upsert.
• • Graph server required — graph writes need a db-worker-node server; the service reuses a running one (including the desktop app's) or logseq_server start launches a headless one. Requests against a stopped server surface as CLI errors.
• • JSON shapes are read at runtime — list/search/query fields follow the CLI's JSON contract and are projected defensively; a future CLI shape change degrades rows rather than crashing.
• • user.property/* values are db-id refs — property values appear as separate value blocks; editing property values through the service writes the value block, not inline key:: value.

Dev Note

Working context for maintainers — click to expand

None.