How to integrate Ahrefs MCP with Vercel AI SDK v6

Connect Vercel AI SDK v6 to Ahrefs MCP. Get domain rating trend for competitor site, list all broken backlinks for your website, and more using natural language, with authentication handled for you.

Ahrefs logoAhrefs
Api KeyOauth2

Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.

46 Tools

Introduction

This guide walks you through connecting Ahrefs to Vercel AI SDK v6 using the Composio tool router. By the end, you'll have a working Ahrefs agent that can analyze backlinks and referring domains, research keywords and search volume, track domain rating, find organic competitors, and check top pages through natural language commands.

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

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

Also integrate Ahrefs with

TL;DR

Here's what you'll learn:
  • How to set up and configure a Vercel AI SDK agent with Ahrefs integration
  • Using Composio's Tool Router to dynamically load and access Ahrefs tools
  • Creating an MCP client connection using HTTP transport
  • Building an interactive CLI chat interface with conversation history management
  • Handling tool calls and results within the Vercel AI SDK framework

What is Vercel AI SDK?

The Vercel AI SDK is a TypeScript library for building AI-powered applications. It provides tools for creating agents that can use external services and maintain conversation state.

Key features include:

  • streamText: Core function for streaming responses with real-time tool support
  • MCP Client: Built-in support for Model Context Protocol via @ai-sdk/mcp
  • Step Counting: Control multi-step tool execution with stopWhen: stepCountIs()
  • OpenAI Provider: Native integration with OpenAI models

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

The Ahrefs MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Ahrefs account. It provides structured and secure access to backlink, keyword, competitor, ranking, and search results data, so your agent can analyze backlinks, compare competitors, review keyword rankings, inspect search results, and discover keyword ideas on your behalf.

  • Backlink and anchor analysis: Have your agent retrieve backlinks, summarize backlink statistics, and examine the anchor text pointing to a website or URL.
  • Competitor research: Let the agent compare competitors based on keyword rankings and organic search performance.
  • Keyword ranking history: Direct your agent to review current rank tracking data and historical keyword performance for a website or domain.
  • Search results and keyword ideas: Instruct your agent to inspect search results for chosen queries and find related search suggestions for a keyword or phrase.
  • Outgoing links and crawler verification: Have your agent review outgoing link statistics for a website or retrieve AhrefsBot IP ranges for crawler verification.

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 you begin, make sure you have:
  • Node.js and npm installed
  • A Composio account with API key
  • An OpenAI API key
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 required dependencies

bash
npm install @ai-sdk/openai @ai-sdk/mcp @composio/core ai dotenv

First, install the necessary packages for your project.

What you're installing:

  • @ai-sdk/openai: Vercel AI SDK's OpenAI provider
  • @ai-sdk/mcp: MCP client for Vercel AI SDK
  • @composio/core: Composio SDK for tool integration
  • ai: Core Vercel AI SDK
  • dotenv: Environment variable management
4

Set up environment variables

bash
OPENAI_API_KEY=your_openai_api_key_here
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here

Create a .env file in your project root.

What's needed:

  • OPENAI_API_KEY: Your OpenAI API key for GPT model access
  • COMPOSIO_API_KEY: Your Composio API key for tool access
  • COMPOSIO_USER_ID: A unique identifier for the user session
5

Import required modules and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Composio } from "@composio/core";
import * as readline from "readline";
import { streamText, type ModelMessage, stepCountIs } from "ai";
import { createMCPClient } from "@ai-sdk/mcp";

const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!process.env.OPENAI_API_KEY) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey,
});
What's happening:
  • We're importing all necessary libraries including Vercel AI SDK's OpenAI provider and Composio
  • The dotenv/config import automatically loads environment variables
  • The MCP client import enables connection to Composio's tool server
6

Create Tool Router session and initialize MCP client

typescript
async function main() {
  // Create a tool router session for the user
  const session = await composio.create(composioUserID!, {
    toolkits: ["ahrefs"],
  });

  const mcpUrl = session.mcp.url;
What's happening:
  • We're creating a Tool Router session that gives your agent access to Ahrefs tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned mcp object contains the URL and authentication headers needed to connect to the MCP server
  • This session provides access to all Ahrefs-related tools through the MCP protocol
7

Connect to MCP server and retrieve tools

typescript
const mcpClient = await createMCPClient({
  transport: {
    type: "http",
    url: mcpUrl,
    headers: session.mcp.headers, // Authentication headers for the Composio MCP server
  },
});

const tools = await mcpClient.tools();
What's happening:
  • We're creating an MCP client that connects to our Composio Tool Router session via HTTP
  • The mcp.url provides the endpoint, and mcp.headers contains authentication credentials
  • The type: "http" is important - Composio requires HTTP transport
  • tools() retrieves all available Ahrefs tools that the agent can use
8

Initialize conversation and CLI interface

typescript
let messages: ModelMessage[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
console.log(
  "Ask any questions related to ahrefs, like summarize my last 5 emails, send an email, etc... :)))\n",
);

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();
What's happening:
  • We initialize an empty messages array to maintain conversation history
  • A readline interface is created to accept user input from the command line
  • Instructions are displayed to guide the user on how to interact with the agent
9

Handle user input and stream responses with real-time tool feedback

typescript
rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({ role: "user", content: trimmedInput });
  console.log("\nAgent is thinking...\n");

  try {
    const stream = streamText({
      model: openai("gpt-5"),
      messages,
      tools,
      toolChoice: "auto",
      stopWhen: stepCountIs(10),
      onStepFinish: (step) => {
        for (const toolCall of step.toolCalls) {
          console.log(`[Using tool: ${toolCall.toolName}]`);
          }
          if (step.toolCalls.length > 0) {
            console.log(""); // Add space after tool calls
          }
        },
      });

      for await (const chunk of stream.textStream) {
        process.stdout.write(chunk);
      }

      console.log("\n\n---\n");

      // Get final result for message history
      const response = await stream.response;
      if (response?.messages?.length) {
        messages.push(...response.messages);
      }
    } catch (error) {
      console.error("\nAn error occurred while talking to the agent:");
      console.error(error);
      console.log(
        "\nYou can try again or restart the app if it keeps happening.\n",
      );
    } finally {
      rl.prompt();
    }
  });

  rl.on("close", async () => {
    await mcpClient.close();
    console.log("\n👋 Session ended.");
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • We use streamText instead of generateText to stream responses in real-time
  • toolChoice: "auto" allows the model to decide when to use Ahrefs tools
  • stopWhen: stepCountIs(10) allows up to 10 steps for complex multi-tool operations
  • onStepFinish callback displays which tools are being used in real-time
  • We iterate through the text stream to create a typewriter effect as the agent responds
  • The complete response is added to conversation history to maintain context
  • Errors are caught and displayed with helpful retry suggestions

Complete Code

Here's the complete code to get you started with Ahrefs and Vercel AI SDK:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Composio } from "@composio/core";
import * as readline from "readline";
import { streamText, type ModelMessage, stepCountIs } from "ai";
import { createMCPClient } from "@ai-sdk/mcp";

const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!process.env.OPENAI_API_KEY) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey,
});

async function main() {
  // Create a tool router session for the user
  const session = await composio.create(composioUserID!, {
    toolkits: ["ahrefs"],
  });

  const mcpUrl = session.mcp.url;

  const mcpClient = await createMCPClient({
    transport: {
      type: "http",
      url: mcpUrl,
      headers: session.mcp.headers, // Authentication headers for the Composio MCP server
    },
  });

  const tools = await mcpClient.tools();

  let messages: ModelMessage[] = [];

  console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n");
  console.log(
    "Ask any questions related to ahrefs, like summarize my last 5 emails, send an email, etc... :)))\n",
  );

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (userInput: string) => {
    const trimmedInput = userInput.trim();

    if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
      console.log("\nGoodbye!");
      rl.close();
      process.exit(0);
    }

    if (!trimmedInput) {
      rl.prompt();
      return;
    }

    messages.push({ role: "user", content: trimmedInput });
    console.log("\nAgent is thinking...\n");

    try {
      const stream = streamText({
        model: openai("gpt-5"),
        messages,
        tools,
        toolChoice: "auto",
        stopWhen: stepCountIs(10),
        onStepFinish: (step) => {
          for (const toolCall of step.toolCalls) {
            console.log(`[Using tool: ${toolCall.toolName}]`);
          }
          if (step.toolCalls.length > 0) {
            console.log(""); // Add space after tool calls
          }
        },
      });

      for await (const chunk of stream.textStream) {
        process.stdout.write(chunk);
      }

      console.log("\n\n---\n");

      // Get final result for message history
      const response = await stream.response;
      if (response?.messages?.length) {
        messages.push(...response.messages);
      }
    } catch (error) {
      console.error("\nAn error occurred while talking to the agent:");
      console.error(error);
      console.log(
        "\nYou can try again or restart the app if it keeps happening.\n",
      );
    } finally {
      rl.prompt();
    }
  });

  rl.on("close", async () => {
    await mcpClient.close();
    console.log("\n👋 Session ended.");
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});

Conclusion

You've successfully built a Ahrefs agent using the Vercel AI SDK with streaming capabilities! This implementation provides a powerful foundation for building AI applications with natural language interfaces and real-time feedback.

Key features of this implementation:

  • Real-time streaming responses for a better user experience with typewriter effect
  • Live tool execution feedback showing which tools are being used as the agent works
  • Dynamic tool loading through Composio's Tool Router with secure authentication
  • Multi-step tool execution with configurable step limits (up to 10 steps)
  • Comprehensive error handling for robust agent execution
  • Conversation history maintenance for context-aware responses

You can extend this further by adding custom error handling, implementing specific business logic, or integrating additional Composio toolkits to create multi-app workflows.
TOOLS

Supported Tools

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

Backlinks stats retrieval

Retrieves comprehensive backlink statistics for a specified website or URL using Ahrefs' Site Explorer tool.

Batch Url Analysis

Performs a batch analysis on multiple URLs or domains using Ahrefs' powerful SEO metrics.

Domain rating for site explorer

Retrieves Ahrefs Domain Rating and Ahrefs Rank for a specified domain or URL on a requested date.

Domain rating history

Retrieves the historical Domain Rating (DR) data for a specified domain over time.

Explore keywords overview

Retrieves keyword-level overview metrics from Ahrefs' Keywords Explorer for specified keywords or an existing keyword list in a country.

Explore keyword volume by country

Retrieves monthly search volume data across countries for a specified keyword using Ahrefs' Keywords Explorer.

Explore linked domains of a site

Retrieves a list of external domains that the specified target website or URL links to, using Ahrefs' Site Explorer functionality.

Explore matching terms for keywords

The keywords_explorer_matching_terms endpoint retrieves a list of keyword phrases that match or contain the specified keyword from Ahrefs' vast database.

Fetch all backlinks

Retrieves a comprehensive list of backlinks for a specified website or URL using Ahrefs' Site Explorer tool.

Fetch broken backlinks data

Retrieves a list of broken backlinks for a specified website using Ahrefs' Site Explorer tool.

Fetch competitors overview

Retrieves a Rank Tracker competitor overview for a project, including comparative keyword ranking and organic search performance data.

Fetch rank tracker overview

Retrieves an Ahrefs Rank Tracker overview for a project, date and device, with ranking and search-performance metrics.

Fetch site explorer referring domains

Retrieves a list of domains that have backlinks pointing to a specified target website.

Fetch total search volume history

Retrieves historical total search volume for keywords associated with a target domain or URL using Ahrefs Site Explorer.

Get content helper topics

Retrieve topics covered by top-ranking pages for a keyword.

Get domain rating free

Retrieve the free Ahrefs Domain Rating for a domain or URL.

Get domain rating top domains

Retrieves domains ordered by Ahrefs Domain Rating.

Get serp overview

Retrieves a SERP overview for one keyword in a specified country, optionally at a historical date.

Get site audit projects

Lists Site Audit projects associated with the authenticated Ahrefs account, with project and crawl status details.

Get site explorer AI responses count

Retrieve AI response citation and page counts for a site.

Get site explorer country metrics

Retrieves country-specific Site Explorer metrics for a target website or URL, including organic traffic and keyword metrics.

Get site explorer crawled pages

Retrieve crawled pages and crawl metadata for a target URL.

Get site explorer linked anchors external

Retrieves anchor text data for external links going out from a target website using Ahrefs Site Explorer.

Get url rating history

Retrieves the historical URL Rating data for a specified URL over time.

Linked anchors explorer

Retrieves information about internal linked anchors for a specified website using the Ahrefs API.

List best by external links

Retrieves pages from a specified website using Ahrefs' Site Explorer best-by-external-links report.

Pages by traffic overview

Retrieves a list of pages from a specified website, ordered by their estimated organic search traffic.

Post Domain Rating Free

Retrieve Domain Rating scores for up to 1,000 target URLs.

Retrieve anchor data

Retrieves anchor text data for a specified website or URL using Ahrefs' Site Explorer tool.

Retrieve best by internal links

Retrieves pages ranked by internal links for a specified website using Ahrefs' Site Explorer.

Retrieve crawler ip ranges

Retrieves the list of IP address ranges used by Ahrefs' web crawler (AhrefsBot).

Retrieve organic competitors

Retrieves organic search competitors for a target domain or URL, with keyword overlap and performance metrics.

Retrieve organic keywords

Retrieves organic keywords data for a specified website using Ahrefs' Site Explorer tool.

Retrieve outlinks stats

Retrieves outgoing-link statistics for a specified website or URL using Ahrefs Site Explorer.

Retrieve paid pages data

Retrieves information about paid pages (PPC advertising) for a specified website using Ahrefs' Site Explorer tool.

Retrieve public crawler ips

Retrieves a list of IP addresses currently used by AhrefsBot, Ahrefs' web crawler.

Retrieve related terms

Retrieves related keyword ideas for a given keyword or keyword list in a specified country.

Retrieve site explorer keywords history

Retrieves historical keyword performance data for a specified website or domain using Ahrefs' Site Explorer.

Retrieve site explorer metrics

Retrieves Site Explorer SEO metrics for a target domain or URL on a specified date, including backlink, referring-page and crawled-page counts.

Retrieve site explorer metrics history

Retrieves historical Site Explorer traffic metrics for a target website or URL over a specified period, including estimated organic and paid traffic and cost.

Retrieve site explorer pages history

Retrieves historical page counts for a target domain or URL from Ahrefs Site Explorer over a specified period.

Retrieve site explorer referring domains history

Retrieves the historical data of referring domains for a specified website or URL over time.

Retrieve subscription limits and usage

Retrieves an Ahrefs account's subscription limits and remaining API usage allowance.

Retrieve top pages from site explorer

Retrieves data about the top-performing pages of a specified website using Ahrefs' Site Explorer tool.

Retrieve volume history

Retrieves the historical search volume data for a specified keyword using Ahrefs' Keywords Explorer tool.

Search suggestions explorer

Retrieves search suggestions for keywords or an existing keyword list using Ahrefs Keywords Explorer.

FAQ

Frequently asked questions

Start with Ahrefs.It takes 30 seconds.

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

Start building