Skip to content

Iris docs: install the Context Gateway TypeScript SDK from npm latest #4467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mich-elle-luna merged 1 commit into from
Nov 4, 2026
Merged

Iris docs: install the Context Gateway TypeScript SDK from npm latest #4467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions content/develop/ai/context-engine/context-gateway/mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,9 @@ Use `redis-iris` for the Python SDK and Iris command-line interface (CLI). For J
| --- | --- | --- |
| Python 3.11 or later | Discovering and calling tools through `redis_iris.ContextGateway`, or opening a direct MCP session through `gateway.client.connect()`. | `pip install redis-iris` |
| CLI, with Python 3.11 or later | Discovering, inspecting, and calling tools from a shell. | Included in `redis-iris`. |
| TypeScript, with Node.js 22 or later | Opening MCP sessions through `ContextGateway` from `@redis-iris/context-gateway`. | `npm install @redis-iris/context-gateway@beta` |
| TypeScript, with Node.js 22 or later | Opening MCP sessions through `ContextGateway` from `@redis-iris/context-gateway`. | `npm install @redis-iris/context-gateway` |
| An existing MCP client or agent framework | Connecting with the Gateway endpoint and credentials. | Use the client's dependencies. A Redis SDK is not required. |

The npm `beta` tag selects the release used by these examples. The default `latest` tag currently selects an older alpha release.

There is no unified TypeScript package corresponding to `redis-iris`. See the [quickstart](/content/develop/ai/context-engine/context-gateway/quickstart.md#install-the-client) for Python, TypeScript, and CLI examples.

Administration uses separate credentials. Python exposes the administration client through `gateway.service`. The TypeScript package exports `ContextGatewayService`. See [Manage Gateways and Upstreams](/content/develop/ai/context-engine/context-gateway/manage-gateways.md).
Expand Down
4 changes: 1 addition & 3 deletions content/develop/ai/context-engine/context-gateway/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,10 @@ Use Node.js 22 or later. Create a project and install the TypeScript SDK and run
mkdir gateway-quickstart
cd gateway-quickstart
npm init -y
npm install @redis-iris/context-gateway@beta
npm install @redis-iris/context-gateway
npm install --save-dev tsx
```

Use the `beta` release channel for these examples. The default `latest` tag currently selects an older alpha release.

-tab-sep-

Use Python 3.11 or later. The same package installs the `iris` command:
Expand Down
Loading