Open Agent Platform Documentation

repository·main·Indexed 23 days ago

https://github.com/langchain-ai/open-agent-platform

A no-code interface for managing and interacting with LangGraph agents deployed on the LangGraph Platform. It supports RAG via LangConnect, tool connectivity via MCP servers, and multi-agent orchestration through an Agent Supervisor. Note: This repository is deprecated; users are recommended to use Agent Builder on LangSmith.

Tokens
13.3K
Snippets
26
Records
73
Agent score
81%

What's inside Open Agent Platform

  1. What is Open Agent Platform?

    main

    Open Agent Platform is a citizen developer platform designed for building, prototyping, and using agents. It provides a web-based interface for managing and interacting with LangGraph agents.

    Key capabilities include:

    • Agent Management: Building and configuring agents via an intuitive UI.
    • RAG Integration: Native support for Retrieval Augmented Generation using LangConnect.
    • MCP Tools: Extending agent capabilities by connecting to Model Context Protocol (MCP) servers.
    • Agent Supervision: Orchestrating multiple agents through an Agent Supervisor.
    • Authentication: Integrated access control and authentication.
  2. What is an Agent in Open Agent Platform

    main

    An Agent is a custom assistant that is mapped to a specific graph within a LangGraph deployment. It serves as a personalized interface for a particular workflow or logic graph.

    Key characteristics of an Agent include:

    • Identity: Each agent has a user-provided name and description.
    • Configurability: Agents use a custom configuration object to define and personalize their behavior. This object allows you to specify parameters such as the model, system prompt, and available tools used by the underlying graph.
  3. Configure API keys for agents

    main

    Agents require API keys for models and tools. In Open Agent Platform, users can configure these keys via the settings page.

    Key behaviors:

    • Runtime Config: Keys set by users are passed to agents under the apiKeys field in the runtime configuration.
    • Supported Keys: The demo agents support OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY, and TAVILY_API_KEY. This is extendable for custom agents.
    • Fallback Logic: Developers can choose to require user-provided keys or fall back to environment variables set in the LangGraph Platform deployment itself.

    Note on Demo Instance:

    • Tools Agent and Supervisor Agent: Use user keys first, then fall back to LangChain team keys.
    • Deep Researcher: Requires users to set their own API keys in OAP.
  4. Understand RAG server authentication

    main

    Authentication for the RAG server is handled via Supabase. The Open Agent Platform passes the Supabase JWT in the Authorization header of every request to the LangConnect server.

    The LangConnect server extracts and verifies this token with Supabase to retrieve a user ID. This ensures that users can only access collections that belong to them. Note that sharing collections between different users is not currently supported.

  5. Backend and RAG server requirements

    main

    Backend Server

    OAP does not require a standalone backend server for the web app to function, provided you have added deployments from the LangGraph Platform to your instance.

    RAG Features

    To use Retrieval Augmented Generation (RAG) features, you must have a LangConnect server running independently. The LangConnect RAG server is designed to be hosted separately from your LangGraph deployments.

  6. Authenticate to LangConnect RAG server

    main

    Authentication for the LangConnect RAG server follows the same pattern as LangGraph authentication.

    1. Client Request: Pass the Supabase JWT in the Authorization header.
    2. Server Verification: The RAG server extracts and verifies the token with Supabase to obtain a user ID.
    3. Access Control: The user ID is used to ensure users can only access their own collections.

    Note: Sharing collections between users is not currently supported.

  7. Configure LangGraph Server authentication with Supabase

    main

    When using pre-built LangGraph agents with Supabase, authentication is handled via JWT tokens rather than LangSmith API keys.

    Request Headers

    To authenticate requests, include the user's Supabase access token (JWT) in the following headers:

    • Authorization: Contains the JWT token.
    • x-supabase-access-token: A duplicate of the JWT. This is required because headers prefixed with x- are included in the configurable fields of the thread, which is necessary for later authentication with the MCP server.

    Server-side Verification

    The LangGraph server's auth middleware extracts and verifies the token with Supabase to retrieve a user ID. This ID ensures users can only access their own agents and threads.

    Note: If you want to allow users to access agents they did not create, you must modify the custom authentication middleware in the LangGraph server to permit access to those specific agents.