README: document the real API and mount pattern - #5
Merged
Conversation
Replace the skeleton-era README (GranolaClient class, no ingress detail) with the shipped client/tools/ingress surface: createGranolaClient, GRANOLA_TOOL_DEFINITIONS, and the binding-store + webhook-registration + mount sequence Scout runs in production.
Add a /ingest quickstart and API surface section covering createGranolaIngest, the bucket-handler and lifecycle contracts, and its relation to /ingress. Replace remaining "two entry points" language now that /ingest has merged to main.
TheGreatAxios
force-pushed
the
docs/readme-real-api
branch
from
August 3, 2026 21:54
851807f to
e45f00e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
createGranolaClient,GRANOLA_TOOL_DEFINITIONS, ingress binding-store/webhook-registration/mount sequence.packages/scout/src/granola/mount.tsandconfig.ts).Test plan
createGranolaClient,transcriptText,speakerLabel,fetchNoteTool,searchNotesTool,GRANOLA_TOOL_DEFINITIONS, ingress exports) againstsrc/tools/index.tsandsrc/ingress/index.ts.