From 328b03e45345943b36f076a53b1b8d55daa324d9 Mon Sep 17 00:00:00 2001 From: vbarda Date: Wed, 18 Dec 2024 13:46:33 -0500 Subject: [PATCH 1/3] docs: make the studio web UI docs more clear --- docs/docs/concepts/langgraph_studio.md | 15 +++++++++------ .../tutorials/langgraph-platform/local-server.md | 11 ++++++++++- 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/docs/concepts/langgraph_studio.md b/docs/docs/concepts/langgraph_studio.md index f4849e6db..db03fc2e1 100644 --- a/docs/docs/concepts/langgraph_studio.md +++ b/docs/docs/concepts/langgraph_studio.md @@ -35,15 +35,18 @@ While in Beta, LangGraph Studio is available for free to all [LangSmith](https:/ If you have deployed your LangGraph application on LangGraph Platform (Cloud), you can access the studio as part of that -### Development server +### Web UI + +You can [run a local in-memory development server](../../tutorials/langgraph-platform/local-server/) that can be used to connect a local LangGraph app with a web version of the studio. +For example, if you start the local server with `langgraph dev` (running at `http://127.0.0.1:2024` by default), you can connect to the studio by navigating to: + +``` +https://smith.langchain.com/studio/?baseUrl=http://127.0.0.1:2024 +``` -LangGraph CLI also contains a command for running an in-memory development server that can be used to connect a local LangGraph app with the studio. See [instructions here](../cloud/reference/cli.md#dev) for more information. -The way this works is that it runs inside your local environment. -It will spin up an in-memory, development server to deploy the graph. -You can then connect to the studio via the Cloud hosted version of LangGraph Platform. -To be clear, the web studio will connect to your locally running server - your agent is still running locally and never leaves your device. +The web UI version of the studio will connect to your locally running server — your agent is still running locally and never leaves your device. ## Studio FAQs diff --git a/docs/docs/tutorials/langgraph-platform/local-server.md b/docs/docs/tutorials/langgraph-platform/local-server.md index c5a564cca..71c2289f3 100644 --- a/docs/docs/tutorials/langgraph-platform/local-server.md +++ b/docs/docs/tutorials/langgraph-platform/local-server.md @@ -86,10 +86,19 @@ This will start up the LangGraph API server locally. If this runs successfully, ## LangGraph Studio Web UI -Test your graph in the LangGraph Studio Web UI by visiting the URL provided in the output of the `langgraph dev` command. +LangGraph Studio Web is a specialized UI that you can connect to LangGraph API server to enable visualization, interaction, and debugging of your application locally. Test your graph in the LangGraph Studio Web UI by visiting the URL provided in the output of the `langgraph dev` command. > - LangGraph Studio Web UI: https://smith.langchain.com/studio/?baseUrl=http://127.0.0.1:2024 +!!! info "Connecting to a server with a custom host/port" + + If you are running the LangGraph API server with a custom host / port, you can point the Studio Web UI at it by changing the `baseUrl` URL param. For example, if you are running your server on port 8000, you can change the above URL to the following: + + ``` + https://smith.langchain.com/studio/baseUrl=http://127.0.0.1:8000 + ``` + + !!! warning "Safari Compatibility" Currently, LangGraph Studio Web does not support Safari when running a server locally. From cf11752b6da8b5c903ba8e66aae5291783cfe0f4 Mon Sep 17 00:00:00 2001 From: vbarda Date: Wed, 18 Dec 2024 14:54:26 -0500 Subject: [PATCH 2/3] update --- docs/docs/concepts/langgraph_studio.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/concepts/langgraph_studio.md b/docs/docs/concepts/langgraph_studio.md index db03fc2e1..fe8838292 100644 --- a/docs/docs/concepts/langgraph_studio.md +++ b/docs/docs/concepts/langgraph_studio.md @@ -25,16 +25,6 @@ The key features of LangGraph Studio are: ## Types -### Desktop app - -LangGraph Studio is available as a [desktop app](https://studio.langchain.com/) for MacOS users. - -While in Beta, LangGraph Studio is available for free to all [LangSmith](https://smith.langchain.com/) users on any plan tier. - -### Cloud studio - -If you have deployed your LangGraph application on LangGraph Platform (Cloud), you can access the studio as part of that - ### Web UI You can [run a local in-memory development server](../../tutorials/langgraph-platform/local-server/) that can be used to connect a local LangGraph app with a web version of the studio. @@ -48,6 +38,16 @@ See [instructions here](../cloud/reference/cli.md#dev) for more information. The web UI version of the studio will connect to your locally running server — your agent is still running locally and never leaves your device. +### Cloud studio + +If you have deployed your LangGraph application on LangGraph Platform (Cloud), you can access the studio as part of that + +### Desktop app + +LangGraph Studio is available as a [desktop app](https://studio.langchain.com/) for MacOS users. + +While in Beta, LangGraph Studio is available for free to all [LangSmith](https://smith.langchain.com/) users on any plan tier. + ## Studio FAQs ### Why is my project failing to start? From e9a657b1b1707ee369768818d41ec736c2bd57d2 Mon Sep 17 00:00:00 2001 From: vbarda Date: Wed, 18 Dec 2024 17:20:21 -0500 Subject: [PATCH 3/3] fix links --- docs/docs/concepts/langgraph_studio.md | 4 ++-- docs/docs/how-tos/local-studio.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/concepts/langgraph_studio.md b/docs/docs/concepts/langgraph_studio.md index fe8838292..a7db8cc47 100644 --- a/docs/docs/concepts/langgraph_studio.md +++ b/docs/docs/concepts/langgraph_studio.md @@ -25,9 +25,9 @@ The key features of LangGraph Studio are: ## Types -### Web UI +### Development server with web UI -You can [run a local in-memory development server](../../tutorials/langgraph-platform/local-server/) that can be used to connect a local LangGraph app with a web version of the studio. +You can [run a local in-memory development server](../tutorials/langgraph-platform/local-server.md) that can be used to connect a local LangGraph app with a web version of the studio. For example, if you start the local server with `langgraph dev` (running at `http://127.0.0.1:2024` by default), you can connect to the studio by navigating to: ``` diff --git a/docs/docs/how-tos/local-studio.md b/docs/docs/how-tos/local-studio.md index 8e4e29f89..cd2ec88cd 100644 --- a/docs/docs/how-tos/local-studio.md +++ b/docs/docs/how-tos/local-studio.md @@ -6,8 +6,8 @@ This guide shows you how to connect your local agent to [LangGraph Studio](../co There are two ways to connect your local agent to LangGraph Studio: +- [Development Server](../concepts/langgraph_studio.md#development-server-with-web-ui): Python package, all platforms, no Docker - [LangGraph Desktop](../concepts/langgraph_studio.md#desktop-app): Application, Mac only, requires Docker -- [Development Server](../concepts/langgraph_studio.md#dev-server): Python package, all platforms, no Docker In this guide we will cover how to use the development server as that is generally an easier and better experience. @@ -23,7 +23,7 @@ You will need to install [`langgraph-cli`](../cloud/reference/cli.md#langgraph-c You will need to make sure to install the `inmem` extras. ```shell -pip install "langgraph-cli[inmem]==0.1.55" +pip install -U "langgraph-cli[inmem]" ``` ## Run the development server