Skip to content
Gryz Docs
Getting started

Get your agent ready for Gryz

Run the Gryz agent onboarding router after connecting an MCP client, with safe local-write consent and a portable manual fallback.

Updated · Reviewed by Jacob

Get your agent ready for Gryz

After you connect and authenticate Gryz MCP, ask your assistant: “Set up Gryz for this workspace.” It should call agent_onboarding. This is the single setup router for publishing, Notes, Agent Memory when enabled, and future Gryz capabilities.

How the setup loop works

  1. The tool asks where instructions should live: the current project, your personal agent configuration, or manual copy.
  2. It returns exactly one action and an opaque continuation.
  3. For a local write, your assistant must show the semantic targets and change summary, then wait for your explicit approval.
  4. Only after the whole action succeeds does the assistant call the tool again with that continuation and the exact acknowledged_action_id.
  5. Repeat until status is current and next is null.

Gryz is stateless between MCP requests. The signed, 24-hour continuation carries setup acknowledgements without a progress table or server session. A changed capability or version can make a later call return new work; current is scoped to the returned registry revision.

Local writes and manual setup

Calling agent_onboarding is read-only on Gryz. A returned write_files action is only a proposal. It always declares downstream_effect: "local_write" and requires_confirmation: true; the assistant must not write until you approve the displayed targets.

Clients without a writable filesystem receive manual_copy instead. Copy the exact marked blocks into the suggested agent instructions and confirm completion before the assistant acknowledges the action. Gryz never accepts an arbitrary destination path, and repo_path is used only to derive a private project key—not as a write target or returned value.

Ask about one capability

Use focus for “how do I use X?” requests:

{ "focus": "notes" }

If that capability is configured, the tool returns usage guidance. If it is unavailable, it says so and lists what is live; the assistant must not invent a second setup_* tool.

OAuth reconnection

The scopes on the credential used for the current MCP request are authoritative. If an OAuth connection lacks a required scope, onboarding proposes a first-party authorization URL. Approve navigation, finish authorization, reconnect the client with the new token, and resume with the continuation. API-key callers are not sent through OAuth merely because they use an API key.

Compatibility

setup_memory remains available only as a deprecated compatibility alias for existing clients. New setup starts with agent_onboarding; its memory capability returns the same project-key derivation, Markdown block, Cursor .mdc block, and placement guidance.

See the complete MCP tool contract or the always-available MCP setup fallback.

Was this page helpful?