[DOCS] Missing `user` field in TypeScript SDK Options reference

Resolved 💬 2 comments Opened Jan 24, 2026 by coygeek Closed Feb 27, 2026

Documentation Type

Missing documentation (feature not documented)

Documentation Location

https://platform.claude.com/docs/en/agent-sdk/typescript

Section/Topic

"Options" section (the Options interface property table)

Current Documentation

The Python SDK Reference (ClaudeAgentOptions) documents a user field:

@dataclass
class ClaudeAgentOptions:
    ...
    user: str | None = None
    ...

| Property | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| user | str \| None | None | User identifier |

The TypeScript SDK Reference Options table lists properties from allowedTools through tools but does not include a user property.

What's Wrong or Missing?

There is a documentation gap between the Python and TypeScript SDK references:

  • Python documents user as an option for identifying users
  • TypeScript omits this field entirely from the Options table

This creates confusion about cross-SDK feature parity:

  • Is user supported in TypeScript but undocumented?
  • Is user a Python-only feature?
  • If Python-only, should users expect this in TypeScript eventually?

For SDK users building applications that need to identify users (for logging, analytics, or multi-tenant scenarios), this gap makes it unclear how to proceed with the TypeScript SDK.

Suggested Improvement

If user is supported in TypeScript:
Add it to the Options table:

| Property | Type | Default | Description |
|:---------|:-----|:--------|:------------|
| user | string | undefined | User identifier |

If user is Python-only:
Add a note to the Python reference clarifying SDK-specific features, or add a cross-SDK compatibility section/matrix documenting which features are available in which SDK.

Impact

High - Prevents users from using a feature

Additional Context

  • Mirror location (TypeScript): platform.claude.com/docs/en/agent-sdk/typescript.md
  • Mirror location (Python): platform.claude.com/docs/en/agent-sdk/python.md
  • This may indicate other undocumented SDK differences that could benefit from a compatibility matrix

View original on GitHub ↗

This issue has 2 comments on GitHub. Read the full discussion on GitHub ↗