docs: Promote MCP content in the left nav and revise the MCP connection component docs #8567
Conversation
dosubot
bot
added
the
size:L
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe documentation was reorganized and updated to clarify and expand on the usage of the MCP connection component, including splitting detailed instructions into a new dedicated page. Deprecated MCP tool components were consolidated in the docs. The sidebar was restructured to group MCP-related documents under a new category, and several sections received clarity and formatting improvements. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Langflow UI
participant MCP Connection Component
participant MCP Server (external or SSE)
User->>Langflow UI: Add MCP Connection Component
User->>Langflow UI: Configure (command or SSE URL)
User->>Langflow UI: Refresh tools
Langflow UI->>MCP Connection Component: Request tool list
MCP Connection Component->>MCP Server (external or SSE): Connect and fetch tools
MCP Server (external or SSE)-->>MCP Connection Component: Return available tools
MCP Connection Component-->>Langflow UI: Display tools
User->>Langflow UI: Enable Tool Mode, connect to Agent
User->>Langflow UI: Run Agent with selected tool
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
Build successful! ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (13)
docs/docs/Components/mcp-client.md (5)
45-45: Add missing comma before disjunction.Insert a comma before “or leave the field blank” to improve readability.
-In the **Tool** field, select a tool that you want this component to use or leave the field blank to allow access to all tools provided by the MCP server. +In the **Tool** field, select a tool that you want this component to use, or leave the field blank to allow access to all tools provided by the MCP server.
49-49: Remove unnecessary comma after component.The comma before “so that” isn’t required.
-...component](/components-agents), so that the agent can use the tool in its responses. +...component](/components-agents) so that the agent can use the tool in its responses.
85-92: Convert emphasis to headings for parameters.Use proper markdown headings (e.g.,
### Inputs/### Outputs) instead of bold text to denote section titles.
90-90: Add missing trailing pipes in table rows.Ensure each table line has both leading and trailing pipes.
-| command | String | Stdio mode only. The MCP server startup command. Default: `uvx mcp-sse-shim@latest`. +| command | String | Stdio mode only. The MCP server startup command. Default: `uvx mcp-sse-shim@latest`. |
100-101: Use consistent list markers.Switch the hyphens in the “See also” list to asterisks to match the rest of the docs.
-* [Use Langflow as an MCP server](/mcp-server) -* [Use a DataStax Astra DB MCP server](/mcp-component-astra) +* [Use Langflow as an MCP server](/mcp-server) +* [Use a DataStax Astra DB MCP server](/mcp-component-astra)docs/docs/Integrations/mcp-component-astra.md (1)
51-53: Fix inconsistent indentation in numbered steps.Remove extra spaces before “10.” and “11.” for uniform formatting.
-10. In the **Agent** component, add your **OpenAI API key**. +10. In the **Agent** component, add your **OpenAI API key**. -11. Open the **Playground**, and then ask the agent, `What collections are available?` +11. Open the **Playground**, and then ask the agent, `What collections are available?`docs/docs/Get-Started/welcome-to-langflow.md (1)
41-42: Use consistent list markers.Switch the dashes to asterisks for the Get started links to match other sections.
-- [Install Langflow](/get-started-installation) -- [Quickstart](/get-started-quickstart) +* [Install Langflow](/get-started-installation) +* [Quickstart](/get-started-quickstart)docs/docs/Concepts/mcp-server.md (1)
355-356: Use consistent list markers.Change the dashes to asterisks in the “See also” list.
-* [Use Langflow as an MCP client](/mcp-client) -* [Use a DataStax Astra DB MCP server](/mcp-component-astra) +* [Use Langflow as an MCP client](/mcp-client) +* [Use a DataStax Astra DB MCP server](/mcp-component-astra)docs/docs/Components/components-tools.md (2)
318-318: Consistent version phrasing.Consider rephrasing to “Deprecated as of Langflow v1.3” to match the style used elsewhere in the docs.
319-319: Format component names as code.Wrap component names in backticks (
MCP Tools (stdio),MCP Tools (SSE)) for clarity and consistency.docs/docs/Concepts/concepts-components.md (3)
23-23: Improve alt text detail.Update the alt text to something like “Component with Component menu visible above selected component” for richer context.
41-42: Format code references.Wrap
build_and_runin backticks (build_and_run) to match the formatting used forbuild_vertex.
43-43: Add space between icon and text.Insert a space between
<Icon ... />and Checkmark to ensure proper rendering and readability.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/docs/Components/components-tools.md(2 hunks)docs/docs/Components/mcp-client.md(1 hunks)docs/docs/Concepts/concepts-components.md(1 hunks)docs/docs/Concepts/mcp-server.md(3 hunks)docs/docs/Get-Started/welcome-to-langflow.md(1 hunks)docs/docs/Integrations/mcp-component-astra.md(4 hunks)docs/sidebars.js(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/Get-Started/welcome-to-langflow.md
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...cts, and get support: * Contribute to Langflow * [Langflow Discord Server](https://discord.gg/Eqks...
(ENGLISH_WORD_REPEAT_RULE)
docs/docs/Concepts/mcp-server.md
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ...://modelcontextprotocol.io/clients) can use use to take actions. ## Prerequisites * A...
(ENGLISH_WORD_REPEAT_RULE)
docs/docs/Components/mcp-client.md
[uncategorized] ~45-~45: Possible missing comma found.
Context: ... a tool that you want this component to use or leave the field blank to allow acces...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~49-~49: The conjunction “so that” does not require a comma.
Context: ...Agent component](/components-agents), so that the agent can use the tool in its respo...
(SO_THAT_UNNECESSARY_COMMA)
[uncategorized] ~59-~59: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...to make sure the MCP server is connected and the selected tool is used by the agent:...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e from the targeted Langflow server. 2. In the [component menu](/concepts-componen...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
docs/docs/Get-Started/welcome-to-langflow.md
41-41: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
42-42: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
docs/docs/Concepts/mcp-server.md
355-355: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
356-356: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
docs/docs/Components/mcp-client.md
85-85: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
90-90: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
92-92: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
101-101: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (14)
docs/sidebars.js (1)
76-83: LGTM!The new “Model Context Protocol (MCP)” category groups the MCP server and client docs logically and aligns with the reorganization.
docs/docs/Integrations/mcp-component-astra.md (3)
10-10: Link updated correctly.The reference now points to the dedicated MCP client page (
/mcp-client).
20-20: Clarified optional starter project step.The note about using an existing flow or blank flow is now explicit and user-friendly.
22-22: Link updated correctly.The replacement instruction now references the MCP client page.
docs/docs/Get-Started/welcome-to-langflow.md (3)
20-21: Refined use-case introduction.Changing to “For example:” shifts from generic to inviting sample scenarios.
27-29: New example use cases added.These links for agent creation and MCP usage map to the updated docs.
37-37: New community resource added.Including the Twitter handle enhances community engagement.
docs/docs/Concepts/mcp-server.md (3)
12-12: Approve updated page description.The new intro clearly states the page’s purpose.
14-14: Approve updated client cross-reference.The link to “Use Langflow as an MCP client” is correct.
20-20: Approve simplified prerequisite.The phrasing “with at least one flow” is concise and clear.
docs/docs/Components/components-tools.md (2)
314-314: Verify the MCP client documentation link.Ensure that the slug
/mcp-clientcorrectly resolves to the new MCP client docs under the Components section (likely/components/mcp-client) rather than a top‐level/mcp-client.
316-316: Heading level looks good.The H3 “MCP Tools (deprecated)” is appropriately nested under the MCP connection section.
docs/docs/Concepts/concepts-components.md (2)
18-27: Great clarification of the Component menu.The new content clearly explains how to access and use the Component menu.
33-35: Component logs instructions are clear.The new “Component logs” section correctly directs users to click the Inspect icon to view logs.
|
Build successful! ✅ |
|
Build successful! ✅ |
|
Hey @aimurphy Could you please follow Conventional Commits guidelines to write the PR title? Since these titles appear in our release notes, we prefer them to be informative about the changes the PR introduces. |
aimurphy
changed the title
@ogabrielluiz Thanks, I haven't used this standard before. Please help me out with some hints if I messed it up. |
github-actions
bot
added
documentation
|
You should avoid mentioning JIRA tickets too because we don't integrate with it. You can mention them in the description, though. Otherwise, LGTM |
aimurphy
changed the title
github-actions
bot
removed
the
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
|
Build successful! ✅ |
…on component docs (langflow-ai#8567) * related links and nav change * create mcp client page and condense mcp tool info * rewrite mcp client content * add mcp to the welcome page * tweak text regarding modes * small style edits * minor edit
…on component docs (langflow-ai#8567) * related links and nav change * create mcp client page and condense mcp tool info * rewrite mcp client content * add mcp to the welcome page * tweak text regarding modes * small style edits * minor edit
…on component docs (langflow-ai#8567) * related links and nav change * create mcp client page and condense mcp tool info * rewrite mcp client content * add mcp to the welcome page * tweak text regarding modes * small style edits * minor edit
Uh oh!
There was an error while loading. Please reload this page.