GroundService gRPC API

GroundService provides access to Ground's deferred news database. Plugins call this to surface attestations in Claude Code sessions via Ground.

Proto file: plugin/grpc/protocol/ground.proto

Service Methods

MethodRequestResponseStreaming
WriteToGroundWriteToGroundRequestWriteToGroundResponseNo
ReadUndeliveredReadUndeliveredRequestReadUndeliveredResponseNo

WriteToGround

WriteToGround inserts an attestation into Ground's SQLite database. Ground delivers these as deferred news on session Stop.


ReadUndelivered

ReadUndelivered returns the detail text from the most recent undelivered deferred message for a given predicate name and project context. Used by plugins to accumulate news across writes.


Message Types

WriteToGroundRequest

FieldTypeDescription
auth_tokenstring-
subjectsstring-
predicatesstring-
contextsstring-
actorsstring-
attributesgoogle.protobuf.Struct-
sourcestring-

WriteToGroundResponse

FieldTypeDescription
successbool-
errorstring-

ReadUndeliveredRequest

FieldTypeDescription
auth_tokenstring-
predicate_namestring-
project_contextstring-

ReadUndeliveredResponse

FieldTypeDescription
detailstring-
errorstring-

← Back to API Index