Module rpc 

JSON-RPC 2.0 types. Handshake is camelCase; issue payloads are snake_case.

Structs

AgendaParams

issue/agenda params. Default days is 14.

AppendParams

issue/append params.

CheckResult

issue/check reply. The counts travel beside the text because the subcommand exits non-zero on an error count and a client needs the same signal.

ClaimParams

issue/claim params. force defaults to false.

ClaimsParams

issue/claims params.

ConsensusParams

issue/consensus params.

CountParams

issue/count params.

CreateParams

issue/create params. Fields match the CLI create verb.

DeedParams

issue/deed params. Both lists absent reads the citations without writing.

DigestParams

issue/digest params.

DigestResult

issue/digest reply.

Event

One entry in the on-disk change log. One entry in the change log.

EventsGenResult

events/gen result.

EventsSinceParams

events/since params.

EventsSinceResult

Pull of the on-disk event log.

FoldParams

issue/fold params.

HygieneParams

issue/hygiene params.

IdParams

Single issue id.

IdentityResult

identity/get result.

InitializeParams

initialize params. camelCase on the wire.

InitializeResult

initialize result. camelCase on the wire.

IssueGetResult

One issue plus the serve revision.

IssueListParams

Filters for issue/list and issue/ready. snake_case on the wire.

IssueListResult

Page of issue rows, or an unchanged marker.

IssueSelected

issue/selected params. Broadcast after issue/open.

JsonRpcError

JSON-RPC error object. Application codes carry data.code.

JsonRpcRequest

JSON-RPC 2.0 request or notification envelope.

JsonRpcResponse

JSON-RPC 2.0 response envelope.

MirrorCheckParams

issue/mirror params. Checks a mirror file’s stamp against the tracker.

MirrorCheckResult

issue/mirror reply.

MutResult

Mutation result shared by create, update, claim, note, and refile.

NormalizeParams

issue/normalize params.

NoteParams

issue/note params.

PingParams

events/ping params.

ProjectDigestResult

One project’s digest inside DigestResult.

ProjectFilterParams

Params for the reads that take an optional project filter: issue/export, issue/graph, issue/roadmap, issue/cycles, issue/check.

ProjectListResult

project/list result.

RecallParams

issue/recall params. depth bounds the blocker walk and defaults to one.

RefileParams

issue/refile params.

RejectParams

issue/reject params. Either to or project has to say where the successor goes.

RelatedParams

issue/related params. Default depth is 2 and limit is 20.

ReportResult

A report-shaped reply: the same text the subcommand prints.

ResolveParams

issue/resolve params.

SearchParams

issue/search params. Default limit is 20.

StaleParams

issue/stale params.

TreeParams

issue/tree params. format is nodes, ascii, or dot.

UpdateParams

issue/update params.

VaultChanged

vault/changed params. Broadcast after a catalog rebuild.

VoteParams

issue/vote params. choice absent reads the tally without casting.

WaitParams

events/wait params. Waits for the corpus generation to pass last, or for id to reach a terminal state when one is given.

WaitResult

events/wait reply. Waiting on a generation fills generation only; waiting on an issue fills state and says whether it gave up.

WalkParams

Params for children, ancestors, impact, and backlinks.

Enums

Error

Wire-level failure for a control client or dispatcher.

JsonRpcId

JSON-RPC request or notification id.

Method

v1 methods the owner advertises on initialize.

Notification

Push notifications. No id on the wire.

Request

Typed v1 request.

Response

Typed v1 result body.

TreeResult

issue/tree result: a node graph or rendered text.

Constants

CONFLICT

Claim conflict (-32009).

CYCLE

Blocker cycle (-32022).

INTERNAL_ERROR

JSON-RPC internal error (-32603).

INVALID_PARAMS

JSON-RPC invalid params (-32602).

INVALID_REQUEST

JSON-RPC invalid request (-32600).

INVALID_STATE

Closed issue or invalid state (-32010).

METHOD_NOT_FOUND

JSON-RPC method not found (-32601).

NOTIFY_ISSUE_SELECTED

Shared selection. Params: IssueSelected.

NOTIFY_SHUTTING_DOWN

Owner is exiting. Params: {}.

NOTIFY_VAULT_CHANGED

Catalog rebuilt. Params: VaultChanged.

NOT_FOUND

Issue not found (-32004).

PARSE_ERROR

JSON-RPC parse error (-32700).

PROTOCOL_VERSION

Protocol version accepted by initialize.

V1_CAPABILITIES

Capability strings returned by initialize (v1). initialize itself is omitted.

Functions

error_from_core

Map a typed core error onto the control-plane codes.

internal_error

-32603 internal error with message.

invalid_params

-32602 invalid params with message.

invalid_request

-32600 invalid request.

method_not_found

-32601 method not found. data.method is method.

parse_error

-32700 parse error.

parse_initialize_params

Parse initialize params. Missing/empty agent and version != 1 are -32602.