How to integrate Outline MCP with Pydantic AI

Connect Pydantic AI to Outline MCP. Summarize latest engineering design documents, create onboarding page for new hires, and more using natural language, with authentication handled for you.

Get started for freeGet a demo
Outline logoOutline
Api Key

Outline is a team knowledge base and wiki for creating, organizing, and sharing documentation. It helps teams keep decisions, guides, and project knowledge easy to find.

101 Tools

Introduction

This guide walks you through connecting Outline to Pydantic AI using the Composio tool router. By the end, you'll have a working Outline agent that can summarize latest engineering design documents, create onboarding page for new hires, find outdated api documentation pages through natural language commands.

This guide will help you understand how to give your Pydantic AI agent real control over a Outline account through Composio's Outline MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Outline with

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • How to set up your Composio API key and User ID
  • How to create a Composio Tool Router session for Outline
  • How to attach an MCP Server to a Pydantic AI agent
  • How to stream responses and maintain chat history
  • How to build a simple REPL-style chat interface to test your Outline workflows

What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.

Key features include:

  • Type Safety: Built on Pydantic for automatic data validation
  • MCP Support: Native support for Model Context Protocol servers
  • Streaming: Built-in support for streaming responses
  • Async First: Designed for async/await patterns

What is the Outline MCP server, and what's possible with it?

The Outline MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Outline account. It provides structured and secure access so your agent can perform Outline operations on your behalf.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account with an active API key
  • Basic familiarity with Python and async programming
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install dependencies

bash
pip install composio pydantic-ai python-dotenv

Install the required libraries.

What's happening:

  • composio connects your agent to external SaaS tools like Outline
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your agent to Composio's API
  • USER_ID associates your session with your account for secure tool access
  • OPENAI_API_KEY to access OpenAI LLMs
5

Import dependencies

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
What's happening:
  • We load environment variables and import required modules
  • Composio manages connections to Outline
  • MCPServerStreamableHTTP connects to the Outline MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant
6

Create a Tool Router Session

python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Outline
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["outline"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
What's happening:
  • We're creating a Tool Router session that gives your agent access to Outline tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use
7

Initialize the Pydantic AI Agent

python
# Attach the MCP server to a Pydantic AI Agent
outline_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[outline_mcp],
    instructions=(
        "You are a Outline assistant. Use Outline tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
What's happening:
  • The MCP client connects to the Outline endpoint
  • The agent uses GPT-5 to interpret user commands and perform Outline operations
  • The instructions field defines the agent's role and behavior
8

Build the chat interface

python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Outline.\n")

while True:
    user_input = input("You: ").strip()
    if user_input.lower() in {"exit", "quit", "bye"}:
        print("\nGoodbye!")
        break
    if not user_input:
        continue

    print("\nAgent is thinking...\n", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
What's happening:
  • The agent reads input from the terminal and streams its response
  • Outline API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns
9

Run the application

python
if __name__ == "__main__":
    asyncio.run(main())
What's happening:
  • The asyncio loop launches the agent and keeps it running until you exit

Complete Code

Here's the complete code to get you started with Outline and Pydantic AI:

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Outline
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["outline"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    outline_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[outline_mcp],
        instructions=(
            "You are a Outline assistant. Use Outline tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Outline.\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "bye"}:
            print("\nGoodbye!")
            break
        if not user_input:
            continue

        print("\nAgent is thinking...\n", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())

Conclusion

You've built a Pydantic AI agent that can interact with Outline through Composio's Tool Router. With this setup, your agent can perform real Outline actions through natural language. You can extend this further by:
  • Adding other toolkits like Gmail, HubSpot, or Salesforce
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Outline for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.
TOOLS

Supported Tools

Every Outline action and event your agent gets out of the box.

Activate User

Tool to activate a previously suspended user in Outline.

Add Group to Collection

Tool to add a group to a collection in Outline.

Add Document User

Tool to add a user membership to a document.

Add Group to Document

Tool to give all members in a group access to a document.

Add User to Group

Tool to add a user to a group.

Add User to Collection

Tool to add a user to a collection with specified permissions.

Archive Document

Tool to archive a document in Outline.

Create Attachment

Tool to create an attachment in Outline.

Create Collection

Tool to create a new collection in Outline.

Create Comment

Tool to create a comment on an Outline document.

Create Document

Tool to create a new document in Outline.

Create Group

Tool to create a new group in Outline.

Create OAuth Client

Tool to create a new OAuth client in Outline.

Create Share

Tool to create a public share link for an Outline document.

Create Star

Tool to create a star for a document or collection in Outline.

Create Template

Tool to create a new template in Outline.

Create View

Tool to create a view for a document.

Delete Attachment

Tool to delete an attachment from Outline.

Delete Collection

Tool to delete a collection and all of its documents from Outline.

Delete Comment

Tool to delete a comment in Outline.

Delete Document

Tool to delete a document in Outline.

Delete File Operation

Tool to delete a file operation and its associated files from Outline.

Delete Group

Tool to delete a group from Outline.

Delete OAuth Authentication

Tool to delete an OAuth authentication in Outline.

Delete OAuth Client

Tool to delete an OAuth client from Outline.

Delete Star

Tool to delete a star from a document in Outline.

Delete Template

Tool to delete a template in Outline.

Delete User

Tool to delete a user in Outline.

Duplicate Document

Tool to duplicate an Outline document.

Duplicate Template

Tool to duplicate an Outline template.

Empty Documents Trash

Tool to permanently delete all documents in the trash.

Export All Collections

Tool to export all collections and their documents in bulk.

Export Collection

Tool to export a collection in markdown, JSON, or HTML format.

Export Document

Tool to export a document from Outline in Markdown, HTML, or PDF format.

Get Attachment Redirect URL

Tool to retrieve an attachment redirect URL from Outline.

Get authentication config

Tool to retrieve authentication configuration options for an Outline workspace.

Get Collection Info

Tool to retrieve a collection by its unique identifier.

Get Collection Documents

Tool to retrieve a collection's document structure as a tree of navigation nodes.

Get Comment

Tool to retrieve a comment by its ID from Outline.

Get Document Info

Tool to retrieve a document from Outline by its UUID, urlId, or shareId.

Get Document Children Structure

Tool to retrieve a document's child structure.

Get File Operation Info

Tool to retrieve the details and current status of a file operation by its unique identifier.

Get Group Info

Tool to retrieve a group by its unique identifier.

Get OAuth Client Info

Tool to retrieve an OAuth client from Outline by its id or clientId.

Get Revision Info

Tool to retrieve a revision by its ID from Outline.

Get Share Info

Tool to retrieve a share object by its unique identifier or by the associated document ID.

Get Template Info

Tool to retrieve a template by its unique identifier.

Get User Info

Tool to retrieve a user by their unique identifier.

Invite Users

Tool to invite users to the Outline workspace.

List Archived Documents

List all archived documents in the Outline workspace.

List Collection Group Memberships

Tool to list all group memberships for a specific collection in Outline.

List collection memberships

Tool to list all individual user memberships for a collection.

List Collections

Tool to list all collections that the authenticated user has access to.

List Comments

Tool to retrieve all comments with optional filtering by document or collection.

List Data Attributes

Tool to list all data attributes in Outline.

List Deleted Documents

Tool to list all deleted documents in the workspace that the current user has access to.

List Document Group Memberships

Tool to list a document's group memberships.

List document memberships

Tool to list users with direct membership to a document.

List Documents

Tool to list all documents in your Outline workspace.

List Document Users

Tool to list all users with access to a document.

List Draft Documents

Tool to list all draft documents belonging to the current user.

List Events

Tool to list all events from the audit trail.

List File Operations

Tool to list all file operations for the workspace.

List Group Memberships

Tool to list all members of a specific group in Outline.

List Groups

Tool to list all groups in the workspace.

List OAuth Authentications

Tool to list all OAuth authentications for the current user.

List OAuth Clients

Tool to list all OAuth clients accessible to the authenticated user.

List Recently Viewed Documents

Tool to list all recently viewed documents by the current user.

List Revisions

Tool to list all revisions for a specific document.

List Shares

Tool to list all share links in the workspace.

List Stars

Tool to list all starred documents and collections for the authenticated user.

List Templates

Tool to list all templates available to the current user.

List Users

Tool to list all users in the workspace.

List Views

Tool to list all users that have viewed a specific document and the overall view count.

Move Document

Tool to move a document to a new location or collection in Outline.

Redirect File Operation

Tool to retrieve a file from Outline by file operation ID.

Remove Collection Group

Tool to remove a group from a collection, revoking access for all group members.

Remove Collection User

Tool to remove a user from a collection.

Remove Document User

Tool to remove a user membership from a document.

Remove Group from Document

Tool to remove a group from a document, revoking access for all group members.

Remove Group User

Tool to remove a user from a group.

Restore Document

Tool to restore a document in Outline.

Restore Template

Tool to restore a previously deleted template in Outline.

Retrieve Auth Info

Tool to retrieve authentication details for the current API key.

Revoke Share

Tool to revoke a share in Outline, making the share link inactive so it can no longer be used to access the document.

Rotate OAuth Client Secret

Tool to rotate the secret for an OAuth client in Outline.

Search Documents

Tool to search all documents in your Outline workspace using keywords.

Search Document Titles

Tool to search document titles in Outline workspace using keywords.

Suspend User

Tool to suspend a user in Outline.

Create Template from Document

Tool to create a template from an existing Outline document.

Unpublish Document

Tool to unpublish a document in Outline.

Update Collection

Tool to update an existing collection's properties in Outline.

Update Comment

Tool to update a comment in Outline.

Update Document

Tool to update a document in Outline.

Update Group

Tool to update an existing group's name in Outline.

Update OAuth Client

Tool to update an existing OAuth client in Outline.

Update Share

Tool to update a share in Outline.

Update Star

Tool to update a star's position in the Outline sidebar.

Update Template

Tool to update an existing template in Outline.

Update User

Tool to update a user's name, avatar, or language preference in Outline.

Update User Role

Tool to change a user's role in Outline workspace.

FRAMEWORKS

How to build Outline MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Outline MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Outline MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Outline MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Outline MCP with Claude Cowork

Codex logo

Codex

Use Outline MCP with Codex

OpenClaw logo

OpenClaw

Use Outline MCP with OpenClaw

Hermes logo

Hermes

Use Outline MCP with Hermes

CLI logo

CLI

Use Outline MCP with CLI

Google ADK logo

Google ADK

Use Outline MCP with Google ADK

LangChain logo

LangChain

Use Outline MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Outline MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Outline MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Outline MCP with LlamaIndex

CrewAI logo

CrewAI

Use Outline MCP with CrewAI

FAQ

Frequently asked questions

With a standalone Outline MCP server, the agents and LLMs can only access a fixed set of Outline tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Outline and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. Pydantic AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Outline tools.

Yes, absolutely. You can configure which Outline scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Outline data and credentials are handled as safely as possible.

Start with Outline.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Outline tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies