From ca613f5e488cc6abc669797a59836e3166558aa7 Mon Sep 17 00:00:00 2001 From: "April I. Murphy" <36110273+aimurphy@users.noreply.github.com> Date: Mon, 30 Jun 2025 14:49:51 -0700 Subject: [PATCH] Docs: Revise component overview page (#8734) * revise component overview page * comment out 1.5 piece * reorg * coderabbit --------- Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com> --- docs/docs/Agents/agents.md | 2 +- .../components-custom-components.md | 2 +- docs/docs/Components/components-tools.md | 4 +- docs/docs/Components/mcp-client.md | 6 +- docs/docs/Concepts/concepts-components.md | 274 ++++++++---------- docs/docs/Concepts/concepts-overview.md | 15 +- .../Google/integrations-google-big-query.md | 2 +- ...s-setup-google-cloud-vertex-ai-langflow.md | 2 +- docs/docs/Support/troubleshooting.md | 4 +- docs/sidebars.js | 2 +- 10 files changed, 137 insertions(+), 176 deletions(-) diff --git a/docs/docs/Agents/agents.md b/docs/docs/Agents/agents.md index 4c62b680d..65d9a9730 100644 --- a/docs/docs/Agents/agents.md +++ b/docs/docs/Agents/agents.md @@ -61,7 +61,7 @@ To unlock the power of the Agent component, connect some tools. 5. Add the **News Search**, **URL**, and **Calculator** components to your flow. 6. Enable **Tool Mode** in the **News Search**, **URL**, and **Calculator** components. -In the [component menu](/concepts-components#component-menu), enable **Tool mode** so you can use the component with an agent. +In the [component's header menu](/concepts-components#component-menus), enable **Tool Mode** so you can use the component with an agent. **Tool Mode** makes a component into a tool by modifying the component's inputs to accept requests from the Agent component to use a tool's available actions. A component in tool mode has a **Toolset** port that you must connect to an Agent component's **Tools** port if you want to allow the agent to use the tool's actions. 7. Connect the **Toolset** port on the three tool components to the **Tools** port on the Agent component. diff --git a/docs/docs/Components/components-custom-components.md b/docs/docs/Components/components-custom-components.md index 2cf57403f..c946ef958 100644 --- a/docs/docs/Components/components-custom-components.md +++ b/docs/docs/Components/components-custom-components.md @@ -216,7 +216,7 @@ Inputs and outputs define how data flows through the component, how it appears i ### Inputs -Inputs are defined in a class-level `inputs` list. When Langflow loads the component, it uses this list to render fields and handles in the UI. Users or other components provide values or connections to fill these inputs. +Inputs are defined in a class-level `inputs` list. When Langflow loads the component, it uses this list to render component fields and [ports](/concepts-components#component-ports) in the UI. Users or other components provide values or connections to fill these inputs. An input is usually an instance of a class from `langflow.io` (such as `StrInput`, `DataInput`, or `MessageTextInput`). The most common constructor parameters are: diff --git a/docs/docs/Components/components-tools.md b/docs/docs/Components/components-tools.md index c9acf43d4..2985f0f60 100644 --- a/docs/docs/Components/components-tools.md +++ b/docs/docs/Components/components-tools.md @@ -23,8 +23,8 @@ The [simple agent starter project](/simple-agent) uses URL and Calculator tools ![Simple agent starter flow](/img/starter-flow-simple-agent.png) -To make a component into a tool that an agent can use, enable **Tool mode** in the component. Enabling **Tool mode** modifies a component input to accept calls from an agent. -If the component you want to connect to an agent doesn't have a **Tool mode** option, you can modify the component's inputs to become a tool. +To make a component into a tool that an agent can use, enable **Tool Mode** in the component. Enabling tool mode modifies a component input to accept calls from an agent. +If the component you want to connect to an agent doesn't have a **Tool Mode** option, you can modify the component's inputs to become a tool. For an example, see [Make any component a tool](/agents-tools#make-any-component-a-tool). ## arXiv diff --git a/docs/docs/Components/mcp-client.md b/docs/docs/Components/mcp-client.md index 6acda5b3f..42708bd7b 100644 --- a/docs/docs/Components/mcp-client.md +++ b/docs/docs/Components/mcp-client.md @@ -32,7 +32,7 @@ This component has two modes, depending on the type of server you want to access To use `npx` server commands, you must first install an LTS release of [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). For an example of an `npx` MCP server in Langflow, see [Connect an Astra DB MCP server to Langflow](/mcp-component-astra). -3. To use environment variables in your server command, enter each variable in the **Env** fields as you would define them in a script, such as `VARIABLE=value`. If the **Env** field isn't shown, enable it in the component's **Controls** in the [component menu](/concepts-components#component-menu). +3. To use environment variables in your server command, enter each variable in the **Env** fields as you would define them in a script, such as `VARIABLE=value`. If the **Env** field isn't shown, enable it in the component's **Controls** in the [component's header menu](/concepts-components#component-menus). :::important Langflow passes environment variables from the `.env` file to MCP, but it doesn't pass global variables declared in the Langflow UI. @@ -46,7 +46,7 @@ This component has two modes, depending on the type of server you want to access At this point, the **MCP connection** component is serving a tool, but nothing is using the tool. The next steps explain how to make the tool available to an [**Agent** component](/components-agents) so that the agent can use the tool in its responses. -6. In the [component menu](/concepts-components#component-menu), enable **Tool mode** so you can use the component with an agent. +6. In the [component's header menu](/concepts-components#component-menus), enable **Tool Mode** so you can use the component with an agent. 7. Connect the **MCP connection** component's **Toolset** port to an **Agent** component's **Tools** port. @@ -72,7 +72,7 @@ A default address appears in the **MCP SSE URL** field. 1. Click to test the endpoint and refresh the **Tools** list. In SSE mode, all flows available from the targeted server are treated as tools. 1. In the **Tool** field, select a flow that you want this component to use, or leave the field blank to allow access to all flows available from the targeted Langflow server. -2. In the [component menu](/concepts-components#component-menu), enable **Tool mode** so you can use the component with an agent. +2. In the [component's header menu](/concepts-components#component-menus), enable **Tool Mode** so you can use the component with an agent. 3. Connect the **MCP connection** component's **Toolset** port to an **Agent** component's **Tools** port. If not already present in your flow, make sure you also attach **Chat input** and **Chat output** components to the **Agent** component. ![MCP component with SSE mode enabled](/img/component-mcp-sse-mode.png) 1. Test your flow to make sure the agent uses your flows to respond to queries: Click **Playground**, and then enter a prompt that uses a flow that you connected through the **MCP connection** component. diff --git a/docs/docs/Concepts/concepts-components.md b/docs/docs/Concepts/concepts-components.md index 3ce682f3f..ed37030fb 100644 --- a/docs/docs/Concepts/concepts-components.md +++ b/docs/docs/Concepts/concepts-components.md @@ -1,95 +1,133 @@ --- -title: Components +title: Components overview slug: /concepts-components --- import Icon from "@site/src/components/icon"; -# Langflow components overview +Components are the building blocks of your flows. +Like classes in an application, each component is designed for a specific use case or integration. -A component is a single building block within a flow with inputs, outputs, functions, and parameters that define its functionality. A single component is like a class within a larger application. +:::tip +Langflow provides keyboard shortcuts for the **Workspace**. -To add a component to a flow, drag it from the **Component** menu to the **Workspace**. +In the Langflow header, click your profile icon, select **Settings**, and then click **Shortcuts** to view the available shortcuts. +::: -Learn more about components and how they work on this page. +## Add a component to a flow {#component-menus} -## Component menu +To add a component to a flow, drag the component from the **Components** menu to the [**Workspace**](/concepts-overview). -All components have a **Component menu** that contains meta settings for the component. +The **Components** menu is organized by component type, and some components are hidden by default: -To access this menu for a specific component, select a component in a flow. -The menu appears above the selected component. +* **Beta components**: These are Langflow's core components. They are grouped by purpose, such as **Inputs** or **Data**. Be aware that these components are in beta and not suitable for production workloads. +* **Legacy components**: You can still use these components, but they are no longer supported. Legacy components are hidden by default; click