Skip to content

Make the README and getting-started quickstarts runnable #44

@nficano

Description

@nficano

The main README quickstart is not runnable against the current SDK. In README.md:59, the snippet creates a MemoryTransport pair but discards the runtime side, never constructs an ARCPRuntime, and then calls client.open(), which waits forever for a handshake reply. In docs/getting-started.md:43, the minimal example does start a runtime, but it leaves ARCPRuntime on the default empty StaticBearerAuth while the client uses ARCPClient.bearer("my-token"), so client.open() fails with ARCPException.Unauthenticated. The same getting-started page also tells readers to swap in WebSocketTransport or StdioTransport for production at docs/getting-started.md:26, but those transports are not currently on the public API surface.

Fix prompt: Update the README and getting-started snippets so a developer can paste and run them as-is. Create both sides of MemoryTransport.pair(), construct an ARCPRuntime, configure authentication consistently by either using AuthScheme.NONE with Capabilities(anonymous = true) on both sides or by adding StaticBearerAuth(mapOf("my-token" to "quickstart")), register any agent that the snippet submits to, call runtime.accept(runtimeTransport), and show receiving the correlated JobAccepted reply. Remove the WebSocket/Stdio production swap language or explicitly mark those transports as planned rather than available. Add a small documentation-snippet test or sample task so the quickstart does not drift again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity:highHigh severity issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions