arcade-mcp/contrib/langchain/README.md
Eric Gustin 3424ec8219
MCP Local (#563)
Versions:
* arcade-mcp\==1.0.0rc1
* arcade-mcp-server\==1.0.0rc1
* arcade-core\==2.5.0rc1
* arcade-tdk\==2.6.0rc1
* arcade-serve\==2.2.0rc1

### Summary
Adds first-class MCP support across Arcade, introduces a new MCP server
and CLI, unifies the project under the arcade-mcp name, overhauls
templates/scaffolding, and improves developer tooling, secrets
management, and examples.

### Highlights
- **MCP Server & Core**
- New MCP server with stdio and HTTP/SSE transports, session management,
resumability, and lifecycle handling.
- FastAPI-like `MCPApp` for building servers with lazy init; integrated
worker+MCP HTTP app option.
- Middleware system (logging and error handling), robust exception
hierarchy, and Pydantic-based settings.
- Async-safe managers for tools, resources, and prompts backed by
registries and locks.
- Developer-facing, transport-agnostic runtime context interfaces (logs,
tools, prompts, resources, sampling, UI, notifications).
- Conversion from Arcade ToolDefinition to MCP tool schema; OpenAI JSON
tool schema converter.
  - Parser supports `@app.tool`/`@app.tool(...)` decorators.

- **CLI**
  - New `mcp` command to run MCP servers with stdio or HTTP/SSE.
- New `secret` command to set/list/unset tool secrets (supports .env
input, preserves original casing for lookups).
- `new` command refactored; option to create a full toolkit package with
scaffolding.
  - `chat` command removed.
- `serve.py` imports updated to `arcade_serve.fastapi.telemetry`;
version retrieval now uses `arcade-mcp`.
  - `show.py` refactor to use new local catalog utilities.
- `display_tool_details` improved: adds “Default” column and handles
nested properties.

- **Configuration & Discovery**
- New `configure.py` to set up Claude Desktop, Cursor, and VS Code to
connect to local or Arcade Cloud MCP servers.
- Discovery utilities to find/install toolkits, build `ToolCatalog`s,
analyze files for tools, load kits from directories (pyproject parsing),
and build minimal toolkits.
- Better handling of provider API key resolution and evaluation suite
loading.

- **Templates & Scaffolding**
- Reorganized template structure (minimal vs full); moved
`.pre-commit-config.yaml`, `.ruff.toml`, license, Makefile, README,
tests, and tools layout to correct paths.
  - Minimal template adds `.env.example` for runtime secret injection.
- Template pyproject updated for MCP servers; includes sample server
with greeting and secret-reveal tools.
  - Authorization flow in templates simplified.

- **Repo-wide Renaming & Examples**
- Migrates references from `arcade-ai` to `arcade-mcp` across READMEs,
scripts, and package metadata.
- Examples updated (LangChain/LangGraph/AI SDK/TypeScript) and package
name changed to `arcade-mcp-sdk`.

- **Evals & Core Utilities**
- Evals now use OpenAI tooling format (`OpenAIToolList`, `to_openai`);
`tool_eval` takes `provider_api_key`.
- Core utilities: fixed `does_function_return_value` by dedenting before
parse; version bump to `2.5.0rc1` and dependency cleanup.

- **Tooling & CI**
- `setup-uv-env` action splits toolkit vs contrib dependency
installation.
- Pre-commit: excludes `libs/arcade-mcp-server/mkdocs.yml` and
`libs/tests/` from YAML and Ruff hooks; Ruff per-file ignores (e.g.,
C901 in `libs/**/*.py`, TRY400 in server docs paths).
- Makefile updates for uv env setup, quality checks, tests, builds, and
new `shell` target.
  - Added Makefile to MCP server library to streamline dev workflow.

- **Cleanup**
  - Removed `claude.json` config.
- Simplified stdio entrypoint; removed unused imports (`arcade_gmail`,
`arcade_search`).

### Breaking Changes
- **CLI**: `chat` command removed; use `mcp`, `secret`, and updated
`new`.
- **Naming**: All users should update references from `arcade-ai` to
`arcade-mcp`.
- **Templates**: File paths moved; downstream scripts referencing old
template locations may need updates.

### Getting Started
- Run an MCP server:
  - `arcade mcp --stdio --toolkits your_toolkit`
  - `arcade mcp --http --toolkits your_toolkit`
- Manage secrets:
  - `arcade secret set your_toolkit KEY=value`
  - `arcade secret list your_toolkit`
  - `arcade secret unset your_toolkit KEY`
- Configure clients:
- `arcade configure` to set up Claude Desktop, Cursor, and VS Code for
local/Arcade Cloud MCP.

---------

Co-authored-by: Sam Partee <sam@arcade-ai.com>
Co-authored-by: Shub <125150494+shubcodes@users.noreply.github.com>
2025-09-25 15:28:15 -07:00

5.6 KiB

Arcade Langchain Integration

License Downloads PyPI

Arcade DocumentationToolkitsPython ClientJavaScript Client

Overview

langchain-arcade allows you to use Arcade tools in your LangChain and LangGraph applications. This integration provides a simple way to access Arcade's extensive toolkit ecosystem, including tools for search, email, document processing, and more.

Installation

pip install langchain-arcade

Basic Usage

1. Initialize the Tool Manager

The ToolManager is the main entry point for working with Arcade tools in LangChain:

import os
from langchain_arcade import ToolManager

# Initialize with your API key
manager = ToolManager(api_key=os.environ["ARCADE_API_KEY"])

# Initialize with specific tools or toolkits
tools = manager.init_tools(
    tools=["Web.ScrapeUrl"],     # Individual tools
    toolkits=["Search"]          # All tools from a toolkit
)

# Convert to LangChain tools
langchain_tools = manager.to_langchain()

2. Use with LangGraph

pip install langgraph

Here's a simple example of using Arcade tools with LangGraph:

from langchain_openai import ChatOpenAI
from langgraph.checkpoint.memory import MemorySaver
from langgraph.prebuilt import create_react_agent

# Create a LangGraph agent
model = ChatOpenAI(model="gpt-4o")
memory = MemorySaver()
graph = create_react_agent(model, tools, checkpointer=memory)

config = {"configurable": {"thread_id": "1", "user_id": "user@example.com"}}
user_input = {"messages": [("user", "List my important emails")]}

for chunk in graph.stream(user_input, config, stream_mode="values"):
    print(chunk["messages"][-1].content)

Using Tools with Authorization in LangGraph

Many Arcade tools require user authorization. Here's how to handle it:

1. Using with prebuilt agents

import os

from langchain_arcade import ToolManager
from langchain_openai import ChatOpenAI
from langgraph.prebuilt import create_react_agent

# Initialize tools
manager = ToolManager(api_key=os.environ["ARCADE_API_KEY"])
manager.init_tools(toolkits=["Github"])
tools = manager.to_langchain(use_interrupts=True)

# Create agent
model = ChatOpenAI(model="gpt-4o")
graph = create_react_agent(model, tools)

# Run the agent with the "user_id" field in the config
# IMPORTANT the "user_id" field is required for tools that require user authorization
config = {"configurable": {"user_id": "user@lgexample.com"}}
user_input = {"messages": [("user", "Star the arcadeai/arcade-mcp repository on GitHub")]}

for chunk in graph.stream(user_input, config, debug=True):
    if chunk.get("__interrupt__"):
        # print the authorization url
        print(chunk["__interrupt__"][0].value)
        # visit the URL to authorize the tool
        # once you have authorized the tool, you can run again and the agent will continue
    elif chunk.get("agent"):
        print(chunk["agent"]["messages"][-1].content)

# see the functional example for continuing the agent after authorization
# and for handling authorization errors gracefully

See the Functional examples in the examples directory that continue the agent after authorization and handle authorization errors gracefully.

Async Support

For asynchronous applications, use AsyncToolManager:

import asyncio
from langchain_arcade import AsyncToolManager

async def main():
    manager = AsyncToolManager(api_key=os.environ["ARCADE_API_KEY"])
    await manager.init_tools(toolkits=["Google"])
    tools = await manager.to_langchain()

    # Use tools with async LangChain/LangGraph components

asyncio.run(main())

Tool Authorization Flow

Many Arcade tools require user authorization. This can be handled in many ways but the ToolManager provides a simple flow that can be used with prebuilt agents and also the functional API. The typical flow is:

  1. Attempt to use a tool that requires authorization
  2. Check the state for interrupts from the NodeInterrupt exception (or Command)
  3. Call manager.authorize(tool_name, user_id) to get an authorization URL
  4. Present the URL to the user
  5. Call manager.wait_for_auth(auth_response.id) to wait for completion
  6. Resume the agent execution

Available Toolkits

Arcade provides many toolkits including:

  • Search: Google search, Bing search
  • Google: Gmail, Google Drive, Google Calendar
  • Web: Crawling, scraping, etc
  • Github: Repository operations
  • Slack: Sending messages to Slack
  • Linkedin: Posting to Linkedin
  • X: Posting and reading tweets on X
  • And many more

For a complete list, see the Arcade Toolkits documentation.

More Examples

For more examples, see the examples directory.