Tianyi Cui 2b447625fa Sync docs with the defineTool DSL and actual demo code 3 månader sedan
..
src 7f024a1a9d Document the codebase thoroughly and tighten type safety 3 månader sedan
README.md 2b447625fa Sync docs with the defineTool DSL and actual demo code 3 månader sedan
cordis.yml 53d1ef4a74 Add runnable echo-agent example 3 månader sedan
package.json 53d1ef4a74 Add runnable echo-agent example 3 månader sedan
start.ts 53d1ef4a74 Add runnable echo-agent example 3 månader sedan

README.md

echo-agent

Runnable demo: stdin chat with a scripted mock model and an echo tool.

What it shows

  • A complete Cordis app loaded from cordis.yml — the standard "stack of plugins" pattern
  • mock-llm.ts — a mock LlmAdapter that streams scripted responses and calls the echo tool when the user types "echo "
  • echo-tool.ts — a tool registered via ctx.tools.register() that echoes text back uppercased
  • session-jsonl.ts — a minimal persistence plugin: write-behind buffering of session/event notifications, drained to a JSONL file at session/flush
  • stdio-chat.ts — a minimal UI plugin: reads stdin lines and send/steers the agent, renders stream deltas, tool calls, and tool results
  • Plugin files

    File Role Key patterns demonstrated
    mock-llm.ts LlmAdapter registration ctx.llm.registerAdapter(['mock-echo'], …), streaming chunks with proper block-start/block-end protocol
    echo-tool.ts Tool registration ctx.tools.register(defineTool(…)) with typed execute args, tool execution returning ContentBlock[]
    session-jsonl.ts Persistence session/event listener + session/flush drain, fiber-dispose cleanup
    stdio-chat.ts UI agent/stream-chunk, session/event (tool/*), stdin→send/steer
    start.ts Bootstrap Context + Loader + plugin-include wired to cordis.yml

    Run

    yarn demo
    # or:
    node --expose-internals --import tsx examples/echo-agent/start.ts
    

    Type a message and press Enter. "echo " triggers a tool call round-trip (the mock model requests the echo tool, which echoes the text uppercased, and the next model step acknowledges it).

    The session is persisted to <session-id>.jsonl in the examples/echo-agent/ directory. Clean up with: rm -f examples/echo-agent/*.jsonl