Skip to content

[TypeScript SDK] Align memory scope naming with Python SDK #93

Description

@santoshkumarradha

The memory scope naming differs between Python and TypeScript SDKs. Python is the reference implementation, so TypeScript should align with it.

Current naming differences

Scope Purpose Python TypeScript (current)
Workflow/Run `run` `workflow`
User/Actor `agent` `actor`
Session `session` `session`
Global `global` `global`

What we need

Update TypeScript to use the same scope names as Python:

  • Change `workflow` → `run`
  • Change `actor` → `agent`

This ensures consistent behavior and documentation across SDKs.

Files to modify

  • sdk/typescript/src/memory/MemoryClient.ts
  • sdk/typescript/src/memory/MemoryInterface.ts
  • sdk/typescript/src/types/ - update any scope type definitions

Documentation (internal team)

This is a breaking change that affects developer experience. Update the SDK documentation to:

  • Update all memory scope references to use new naming
  • Add migration notes for users upgrading
  • Ensure consistency with Python SDK documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions