Skip to content

docs(sdk): add wren-langchain SDK guide for agent builders#2254

Merged
goldmedal merged 2 commits into
mainfrom
feat/add-langchain-sdk-doc
May 13, 2026
Merged

docs(sdk): add wren-langchain SDK guide for agent builders#2254
goldmedal merged 2 commits into
mainfrom
feat/add-langchain-sdk-doc

Conversation

@PaulChen79
Copy link
Copy Markdown
Contributor

@PaulChen79 PaulChen79 commented May 11, 2026

Summary

  • New doc at docs/core/sdk/langchain.md for users building LangChain or LangGraph agents on top of a Wren project
  • Agent-friendly: short sections, tables for option matrices, code-first style, no marketing fluff
  • Front-loaded caution callout pointing readers at the install guide so the CLI-first ordering can't be skipped

What's covered

  • Prerequisites — minimum CLI bootstrap (profile addcontext initset-profilecontext build) with caution + install-guide link
  • Installation — single pip install line + extras table (datasource pass-through, memory, all)
  • Quickstart — 10-line runnable example using langchain.agents.create_agent
  • API Referencefrom_project(), get_tools(), system_prompt() signatures; 6 LLM-facing tools; direct Python API
  • Integration patterns — three patterns: read-only memory / LangGraph custom loop / multi-project federation
  • Troubleshooting — 4 common pitfalls in a symptom → cause → fix table
  • Compatibility + Limitations — version matrix and known constraints

Test plan

  • Renders correctly on local markdown preview
  • All internal links resolve (../get_started/connect.md, ../get_started/installation.md)
  • Reviewer: skim the doc top-to-bottom against an agent's "first time touching the SDK" mental model — does it answer the 80% questions without making them open the GitHub README?

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive wren-langchain SDK guide with installation, Python quickstart, API reference, integration patterns, troubleshooting, compatibility, and an SDK overview describing available integrations and access modes.
  • Chores
    • Updated docs sync workflow to include SDK documentation so new SDK pages are published during documentation syncs.

Review Change Stack

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 11, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3488417f-2c78-4388-a0a1-2f442651fae1

📥 Commits

Reviewing files that changed from the base of the PR and between 30a6007 and f2ac282.

📒 Files selected for processing (3)
  • .github/workflows/sync-docs.yml
  • docs/core/sdk/langchain.md
  • docs/core/sdk/overview.md
✅ Files skipped from review due to trivial changes (2)
  • docs/core/sdk/overview.md
  • docs/core/sdk/langchain.md

Walkthrough

Adds two new SDK documentation pages (overview and wren-langchain guide) covering setup, installation, quickstart, API reference, integration patterns, troubleshooting, compatibility, and limitations; and updates the docs sync workflow to include SDK docs in site builds.

Changes

wren-langchain SDK Documentation

Layer / File(s) Summary
Overview / Intro
docs/core/sdk/overview.md, docs/core/sdk/langchain.md
Adds SDK overview and introduces the wren-langchain SDK and its purpose.
Prerequisites & Installation
docs/core/sdk/langchain.md
Documents CLI bootstrap prerequisites and pip extras for datasources and optional memory tools.
Quickstart Example
docs/core/sdk/langchain.md
Python quickstart: WrenToolkit.from_project(), agent setup with toolkit tools and system prompt, sample query.
API Reference & Tools
docs/core/sdk/langchain.md
Documents from_project, get_tools, system_prompt; lists LLM-facing tools and memory helpers; shows direct Python query/plan/run usage.
Integration Patterns
docs/core/sdk/langchain.md
Describes read-only memory mode, LangGraph custom loop with tool routing, and multi-project coordination via separate toolkits/agents.
Troubleshooting, Compatibility & Limits
docs/core/sdk/langchain.md
Troubleshooting steps, compatibility expectations, and limitations (sync-only tools, one toolkit per agent, no hot reload, memory index concurrency).

Docs Sync Workflow Update

Layer / File(s) Summary
Workflow triggers & copy list
.github/workflows/sync-docs.yml
Includes docs/core/sdk/** in push path filters and adds sdk to the directory-copy loop so SDK docs are synced to the site.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • wwwy3y3
  • chilijung

Poem

🐰 A rabbit reads the docs at dawn,
New pages sprout across the lawn.
Toolkits ready, agents play,
SDK paths lead the way.
Sync the site and let them hop—hooray!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(sdk): add wren-langchain SDK guide for agent builders' accurately and specifically describes the main change—adding documentation for the wren-langchain SDK targeting agent builders.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/add-langchain-sdk-doc

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/core/sdk/langchain.md (1)

205-205: ⚡ Quick win

Consider clarifying the async bridge behavior.

The statement "LangChain auto-bridges to a thread pool when tools run in async LangGraph" makes a specific claim about LangChain's internal threading behavior. Consider:

  1. Adding a reference or link to LangChain documentation that describes this behavior
  2. Specifying which version of LangChain introduced this behavior
  3. Providing guidance on how to configure the thread pool size if the default executor is insufficient

This will help users better understand the performance implications and potential workarounds for high-concurrency scenarios.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/core/sdk/langchain.md` at line 205, Update the "Synchronous tools only."
bullet to clarify LangChain's async-to-thread-bridge: cite a LangChain
documentation link that describes the bridge behavior, state the minimum
LangChain release/version where this behavior appears, and add a short note on
configuring the executor (e.g., how to increase ThreadPoolExecutor max_workers
or relevant LangChain/env configuration) so readers know how to avoid exhausting
the default executor for high-concurrency async LangGraph workloads; keep the
new text concise and targeted to the existing "Synchronous tools only." sentence
referencing "LangChain auto-bridges" and "async LangGraph".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/core/sdk/langchain.md`:
- Line 205: Update the "Synchronous tools only." bullet to clarify LangChain's
async-to-thread-bridge: cite a LangChain documentation link that describes the
bridge behavior, state the minimum LangChain release/version where this behavior
appears, and add a short note on configuring the executor (e.g., how to increase
ThreadPoolExecutor max_workers or relevant LangChain/env configuration) so
readers know how to avoid exhausting the default executor for high-concurrency
async LangGraph workloads; keep the new text concise and targeted to the
existing "Synchronous tools only." sentence referencing "LangChain auto-bridges"
and "async LangGraph".

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: b94c8075-f4fe-4ed3-b5e3-07a1818f04ea

📥 Commits

Reviewing files that changed from the base of the PR and between ba187b7 and 30a6007.

📒 Files selected for processing (1)
  • docs/core/sdk/langchain.md

New doc at docs/core/sdk/langchain.md targeting users building
LangChain or LangGraph agents on top of a Wren project. Covers
installation extras, three-line quickstart, API reference (toolkit
methods + 6 LLM-facing tools + direct Python API), three integration
patterns (read-only memory / LangGraph custom loop / multi-project
federation), and a troubleshooting table. Front-loaded caution
points readers at the install guide before they touch the SDK.
@PaulChen79 PaulChen79 force-pushed the feat/add-langchain-sdk-doc branch from 30a6007 to f2ac282 Compare May 11, 2026 04:31
@github-actions github-actions Bot added the ci label May 11, 2026
@PaulChen79 PaulChen79 self-assigned this May 13, 2026
Copy link
Copy Markdown
Collaborator

@goldmedal goldmedal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @PaulChen79 👍

@goldmedal goldmedal merged commit 1f92027 into main May 13, 2026
4 checks passed
@goldmedal goldmedal deleted the feat/add-langchain-sdk-doc branch May 13, 2026 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants