How to integrate Shortcut MCP with Vercel AI SDK

Framework Integration Gradient
Shortcut Logo
Vercel AI SDK Logo
divider

Introduction

This guide walks you through connecting Shortcut to Vercel AI SDK using the Composio tool router. By the end, you'll have a working Shortcut agent that can create a new epic for q3 goals, add a threaded comment to our launch epic, start a new iteration for next sprint, make a group for the mobile team through natural language commands.

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

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

TL;DR

Here's what you'll learn:
  • How to set up and configure a Vercel AI SDK agent with Shortcut integration
  • Using Composio's Tool Router to dynamically load and access Shortcut 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
  • Step Counting: Control multi-step tool execution
  • OpenAI Provider: Native integration with OpenAI models

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

The Shortcut MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Shortcut account. It provides structured and secure access to your project management workspace, so your agent can perform actions like creating epics, organizing teams, adding comments, managing sprints, and labeling tasks on your behalf.

  • Epic and story management: Direct your agent to create new epics, add threaded comments, or reply to existing discussions to streamline project tracking and collaboration.
  • Iteration and sprint planning: Let your agent set up new iterations, define sprint cycles, and associate tasks or groups, making agile planning and progress tracking a breeze.
  • Team and group organization: Effortlessly create and customize new groups or teams, assign members, and link workflows to keep your workspace structure organized and aligned.
  • Label and category creation: Ask your agent to generate new categories or labels, helping you organize stories, tasks, and priorities for efficient project management.
  • Linked file integration: Enable your agent to attach or create linked files within Shortcut, keeping all your project resources and documentation accessible and up to date.

Supported Tools & Triggers

Tools
Create categoryCreate category allows you to create a new category in shortcut.
Create entity templateCreate a new entity template for the workspace.
Create epicCreate epic allows you to create a new epic in shortcut.
Create epic commentThis endpoint allows you to create a threaded comment on an epic.
Create epic comment commentThis endpoint allows you to create a nested comment reply to an existing epic comment.
Create groupCreates a new group in the shortcut system with customizable properties.
Create iterationThe createiteration endpoint allows you to create a new iteration in shortcut, which represents a time-boxed period for completing a set of stories or tasks.
Create labelCreate label allows you to create a new label in shortcut.
Create linked fileCreate linked file allows you to create a new linked file in shortcut.
Create milestone(deprecated: use 'create objective') create milestone allows you to create a new milestone in shortcut.
Create multiple storiesCreate multiple stories allows you to create multiple stories in a single request using the same syntax as [create story](https://developer.
Create objectiveCreate objective allows you to create a new objective in shortcut.
Create projectCreate project is used to create a new shortcut project.
Create storyCreate story is used to add a new story to your shortcut workspace.
Create story commentCreate comment allows you to create a comment on any story.
Create story from templateCreate story from template is used to add a new story derived from a template to your shortcut workspace.
Create story linkStory links (called story relationships in the ui) allow you create semantic relationships between two stories.
Create story reactionCreate a reaction to a story comment.
Create taskCreate task is used to create a new task in a story.
Delete categoryDelete category can be used to delete any category.
Delete custom fieldDeletes a specific custom field from the shortcut system using its unique public identifier.
Delete entity templateDeletes a specific entity template from the shortcut api.
Delete epicDelete epic can be used to delete the epic.
Delete epic commentThis endpoint allows you to delete a comment from an epic.
Delete fileDelete file deletes a previously uploaded file.
Delete iterationDeletes a specific iteration from the shortcut project management system.
Delete labelDelete label can be used to delete any label.
Delete linked fileDelete linked file can be used to delete any previously attached linked-file.
Delete milestone(deprecated: use 'delete objective') delete milestone can be used to delete any milestone.
Delete multiple storiesDelete multiple stories allows you to delete multiple archived stories at once.
Delete objectiveDelete objective can be used to delete any objective.
Delete projectDelete project can be used to delete a project.
Delete storyDelete story can be used to delete any story.
Delete story commentDelete a comment from any story.
Delete story linkRemoves the relationship between the stories for the given story link.
Delete story reactionDelete a reaction from any story comment.
Delete taskDelete task can be used to delete any previously created task on a story.
Disable iterationsDisables iterations for the current workspace
Disable story templatesDisables the story template feature for the workspace.
Enable iterationsEnables iterations for the current workspace
Enable story templatesEnables the story template feature for the workspace.
Get categoryGet category returns information about the selected category.
Get current member infoReturns information about the authenticated member.
Get custom fieldRetrieves detailed information about a specific custom field in shortcut using its unique public identifier.
Get entity templateGet entity template returns information about a given entity template.
Get epicGet epic returns information about the selected epic.
Get epic commentThis endpoint returns information about the selected epic comment.
Get epic workflowReturns the epic workflow for the workspace.
Get external link storiesGet stories which have a given external link associated with them.
Get fileGet file returns information about the selected uploadedfile.
Get groupRetrieves detailed information about a specific group in the shortcut workspace using its unique public identifier.
Get iterationRetrieves detailed information about a specific iteration in the shortcut project management system.
Get key resultGet key result returns information about a chosen key result.
Get labelGet label returns information about the selected label.
Get linked fileGet file returns information about the selected linked file.
Get memberReturns information about a member.
Get milestone(deprecated: use 'get objective') get milestone returns information about a chosen milestone.
Get objectiveGet objective returns information about a chosen objective.
Get projectGet project returns information about the selected project.
Get repositoryGet repository returns information about the selected repository.
Get storyGet story returns information about a chosen story.
Get story commentGet comment is used to get comment information.
Get story linkReturns the stories and their relationship for the given story link.
Get taskReturns information about a chosen task.
Get workflowGet workflow returns information about a chosen workflow.
List categoriesList categories returns a list of all categories and their attributes.
List category milestonesList category milestones returns a list of all milestones with the category.
List category objectivesReturns a list of all objectives with the category.
List custom fieldsRetrieves a list of all custom fields defined in the shortcut api.
List entity templatesList all the entity templates for the workspace.
List epic commentsGet a list of all comments on an epic.
List epicsList epics returns a list of all epics and their attributes.
List epic storiesGet a list of all stories in an epic.
List filesList files returns a list of all uploadedfiles in the workspace.
List groupsA group in our api maps to a "team" within the shortcut product.
List group storiesList the stories assigned to the group.
List iterationsRetrieves a list of all iterations in the shortcut project management system.
List iteration storiesGet a list of all stories in an iteration.
List label epicsList all of the epics with the label.
List labelsList labels returns a list of all labels and their attributes.
List label storiesList all of the stories with the label.
List linked filesList linked files returns a list of all linked-files and their attributes.
List membersReturns information about members of the workspace.
List milestone epics(deprecated: use 'list objective epics') list all of the epics within the milestone.
List milestones(deprecated: use 'list objectives') list milestones returns a list of all milestones and their attributes.
List objective epicsList all of the epics within the objective.
List objectivesList objectives returns a list of all objectives and their attributes.
List projectsList projects returns a list of all projects and their attributes.
List repositoriesList repositories returns a list of all repositories and their attributes.
List storiesList stories returns a list of all stories in a selected project and their attributes.
List story commentLists comments associated with a story
List workflowsReturns a list of all workflows in the workspace.
SearchSearch lets you search epics and stories based on desired parameters.
Search epicsSearch epics lets you search epics based on desired parameters.
Search iterationsSearch iterations lets you search iterations based on desired parameters.
Search milestonesSearch milestones lets you search milestones based on desired parameters.
Search objectivesSearch objectives lets you search objectives based on desired parameters.
Search storiesSearch stories lets you search stories based on desired parameters.
Search stories oldSearch stories lets you search stories based on desired parameters.
Story historyRetrieves the complete history of changes for a specific story in the shortcut project management system.
Unlink comment thread from slackUnlinks a comment from its linked slack thread (comment replies and slack replies will no longer be synced)
Unlink productboard from epicThis endpoint allows you to unlink a productboard epic.
Update categoryUpdate category allows you to replace a category name with another name.
Update custom fieldUpdate custom field can be used to update the definition of a custom field.
Update entity templateUpdate an entity template's name or its contents.
Update epicUpdate epic can be used to update numerous fields in the epic.
Update epic commentThis endpoint allows you to update a threaded comment on an epic.
Update fileUpdate file updates the properties of an uploadedfile (but not its content).
Update groupUpdates an existing group in the shortcut workspace.
Update iterationThis endpoint allows you to update an existing iteration in shortcut.
Update key resultUpdate key result allows updating a key result's name or initial, observed, or target values.
Update labelUpdate label allows you to replace a label name with another name.
Update linked fileUpdated linked file allows you to update properties of a previously attached linked-file.
Update milestone(deprecated: use 'update objective') update milestone can be used to update milestone properties.
Update multiple storiesUpdate multiple stories allows you to make changes to numerous stories at once.
Update objectiveUpdate objective can be used to update objective properties.
Update projectUpdate project can be used to change properties of a project.
Update storyUpdate story can be used to update story properties.
Update story commentUpdate comment replaces the text of the existing comment.
Update story linkUpdates the stories and/or the relationship for the given story link.
Update taskUpdate task can be used to update task properties.
Upload filesUpload files uploads one or many files and optionally associates them with a story.

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

What is Tool Router?

Composio's Tool Router 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 Tool Router

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

How the Tool Router works

The Tool Router 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

Prerequisites

Before you begin, make sure you have:
  • Node.js and npm installed
  • A Composio account with API key
  • An OpenAI API key

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.

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

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

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 { experimental_createMCPClient as 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

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: ["shortcut"],
  });

  const mcpUrl = session.mcp.url;
What's happening:
  • We're creating a Tool Router session that gives your agent access to Shortcut 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 Shortcut-related tools through the MCP protocol

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 Shortcut tools that the agent can use

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 shortcut, 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

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 Shortcut 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 Shortcut 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 { experimental_createMCPClient as 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: ["shortcut"],
  });

  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 shortcut, 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 Shortcut 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.

How to build Shortcut MCP Agent with another framework

FAQ

What are the differences in Tool Router MCP and Shortcut MCP?

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

Can I use Tool Router MCP with Vercel AI SDK?

Yes, you can. Vercel AI SDK 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 Shortcut tools.

Can I manage the permissions and scopes for Shortcut while using Tool Router?

Yes, absolutely. You can configure which Shortcut 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.

How safe is my data with Composio Tool Router?

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 Shortcut data and credentials are handled as safely as possible.

Used by agents from

Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.