Skip to content

docs: add agent framework integration and Context7 indexing guidance #98

@EfeDurmaz16

Description

@EfeDurmaz16

Context

ACK has strong protocol and demo material, but it would be easier for agent-framework users to adopt if there were a small integration/indexing track for the places where agent developers already look for docs and examples.

A few useful surfaces:

  • Context7 indexing so ACK docs can be pulled into coding agents more reliably
  • OpenAI Agents SDK examples
  • Claude Agent SDK examples
  • Vercel AI SDK examples
  • lightweight adapters or cookbook examples for common agent runtimes

Proposal

Add a small docs/integration task that makes ACK easier to discover and use from agent frameworks:

  1. Make sure ACK docs are indexable by Context7 or provide the metadata/docs structure needed for indexing.
  2. Add one minimal framework example showing an agent discovering/using ACK commerce primitives.
  3. Document the intended adapter boundary: ACK primitives stay protocol-level, framework adapters stay thin.
  4. Optionally track SDK/example requests for additional languages if maintainers want that surfaced explicitly.

Why this helps

  • Agent developers often start inside framework docs rather than protocol repos.
  • Thin examples can show how ACK composes with agent loops without coupling ACK core to a specific framework.
  • Context7 indexing would make ACK easier for coding agents to reference accurately.
  • This can also create a path for community SDK/example contributions in languages beyond TypeScript.

Small first slice

I would start with docs only:

  • Add a short docs/integrations/agent-frameworks page or similar.
  • Include one minimal OpenAI Agents SDK or Vercel AI SDK example.
  • Add Context7 indexing notes/metadata if accepted by maintainers.
  • Keep any runtime adapter code as a follow-up PR.

I can help with the first docs PR and, if useful, follow up with additional language SDK/examples in small separate PRs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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