ServiceNow with Vercel AI SDK

How to integrate ServiceNow MCP with Vercel AI SDK v6

Trusted by

GET STARTED FOR FREE GET A DEMO

30 min · no commitment · see it on your stack

Introduction Also integrate ServiceNow with TL;DR What is Vercel AI SDK What is the ServiceNow MCP server Supported Tools & Triggers Creating MCP Server - Stand-alone vs Composio SDK Step-by-step Guide Complete Code Conclusion How to build ServiceNow MCP Agent with another framework Explore Other Toolkits FAQ

Connect ServiceNow without Auth hassles

We manage OAuth, API Key, token refresh, and scopes, you just build.

Try for Free

Introduction

This guide walks you through connecting ServiceNow to Vercel AI SDK v6 using the Composio tool router. By the end, you'll have a working ServiceNow agent that can list all open incidents assigned to me, create a new servicenow change request, update priority of ticket inc0012345 to high through natural language commands.

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

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

Also integrate ServiceNow with

ChatGPT Antigravity OpenAI Agents SDK Claude Agent SDK Claude Code Claude Cowork Codex OpenCode Cursor VS Code OpenClaw Hermes CLI Google ADK LangChain Mastra AI LlamaIndex CrewAI

TL;DR

Here's what you'll learn:

How to set up and configure a Vercel AI SDK agent with ServiceNow integration
Using Composio's Tool Router to dynamically load and access ServiceNow 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 ServiceNow MCP server, and what's possible with it?

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

Supported Tools & Triggers

Tools

Attach file to recordAttaches a file to a specified record in a ServiceNow table.

Cancel change conflict checkCancels the running conflict checking process for a specified ServiceNow change request.

Create a recordCreates a new record in a specified ServiceNow table with the provided field values.

Create attachment uploadUploads a file as a multipart form-data attachment to a specified record in ServiceNow.

Create CI Lifecycle Management ActionAdds a specified configuration item (CI) action using the ServiceNow CI Lifecycle Management API.

Create ci lifecycle mgmt operatorsRegisters a new operator for a non-workflow user in the ServiceNow CI Lifecycle Management system.

Set CI Operational StateSets the operational state for one or more configuration items (CIs) using the ServiceNow CI Lifecycle Management API.

Create CMDB Application ServiceCreates an application service in ServiceNow CMDB or updates an existing one if a service with the same name already exists.

Create CMDB Linux ServerCreates a new Linux server configuration item (CI) in the ServiceNow CMDB.

Ingest CMDB RecordsInserts multiple records into a ServiceNow Import Set staging table.

Create CMDB InstanceCreates a single Configuration Item (CI) in ServiceNow CMDB with the specified attributes.

Create CMDB Instance RelationCreates an inbound and/or outbound relation for a specific configuration item (CI) in the ServiceNow CMDB.

Create data classification classifyAssigns pre-defined or user-defined data classification labels to records in ServiceNow tables.

Create data classification clearRemoves all data classifications for a specific record in a ServiceNow table.

Enhanced CI Identify/ReconcileInserts or updates configuration items (CIs) in ServiceNow CMDB using the enhanced Identification and Reconciliation API.

Query CMDB Identify ReconcileQueries the ServiceNow Identify and Reconcile API to determine whether a Configuration Item (CI) should be inserted (created) or updated in the CMDB based on identity matching rules.

CMDB Identify Reconcile QueryEnhancedPerforms identification and reconciliation of configuration items (CIs) in the ServiceNow CMDB.

Create Import SetInserts incoming data into a specified ServiceNow staging table and triggers the associated transform map to move the data into the production table.

Create incidentCreates a new incident record in ServiceNow with the provided details.

Create IncidentCreates a new incident record in ServiceNow with the provided field values.

Create ServiceNow InteractionCreates a new interaction record in ServiceNow that can be linked to records in other tables (e.

Close InteractionCloses an existing interaction record in ServiceNow by changing its state to closed.

Create push installationRegisters or updates a device token for receiving push notifications through ServiceNow.

Remove Push InstallationDeactivates a mobile device installation from receiving push notifications using the ServiceNow Push Installation API.

Create servic catalog items add to cartAdds a specified catalog item to the current user's ServiceNow shopping cart.

Submit Service Catalog Producer ItemSubmits a ServiceNow Service Catalog item using the submit_producer endpoint.

Checkout Service Catalog CartChecks out the Service Catalog shopping cart and submits the order as a request.

Submit Service Catalog Cart OrderSubmits the Service Catalog shopping cart and creates a service catalog request.

Create servicecatalog items checkout guideChecks out an order guide by updating variable values for selected catalog items.

Order Service Catalog Item NowOrders a specified ServiceNow Service Catalog item immediately.

Insert Multiple Import Set RecordsInserts multiple records into a specified ServiceNow staging table and triggers the associated transform map.

Create sn chg rest changeCreates a new change request in ServiceNow using the Change Management REST API.

Create Change Request CI AssociationCreates an association between a change request and one or more configuration items (CIs) in ServiceNow.

Start Change Conflict CheckStarts the conflict checking process for a ServiceNow change request, identifying scheduling conflicts with other changes or blackout windows.

Create sn chg rest change emergencyCreates an emergency change request in ServiceNow using the Change Management API.

Create Normal Change RequestCreates a normal change request in ServiceNow using the Change Management REST API.

Create sn chg rest change standardCreates a new standard change request in ServiceNow using a pre-approved standard change template.

Create Change TaskCreates a new task for a ServiceNow change request using the Change Management REST API.

Create sn cicd app batch installInstalls two or more ServiceNow application packages in a single batch operation via the CICD API.

Install App from RepositoryInstalls the specified application from the ServiceNow app repository.

Run Full Instance ScanInitiates a full instance scan by running all active checks present in the ServiceNow instance.

Create sn cicd instance scan suite scan comboRuns a CI/CD scan using a suite and target (scoped app) combination in ServiceNow.

Activate PluginActivates the specified plugin in ServiceNow's CICD Plugin API.

Run Test SuiteStarts a specified automated test suite using ServiceNow's CI/CD Pipeline API.

Create SD-WAN Trouble TicketCreates a new trouble ticket in ServiceNow using the Service Operations Workspace Trouble Ticket Open API.

Create TMF Service CategoryCreates a new service category record in the ServiceNow TMF Service Catalog API.

Create tableInserts a new record into the specified ServiceNow table with the provided field values.

Create ServiceNow IncidentCreates a new incident record in the ServiceNow incident table using the Table API.

Create or Update CMDB CI via IRECreates or updates CMDB configuration items (CIs) using the ServiceNow Identification and Reconciliation Engine (IRE) via the identify-reconcile endpoint.

Delete a recordPermanently deletes a specific record from a ServiceNow table using its sys_id.

Delete attachment byPermanently deletes a specific attachment from ServiceNow using its sys_id.

Delete attachment by id v1Permanently deletes a specific attachment from ServiceNow using its sys_id via the v1 API endpoint.

Delete attachment csmPermanently deletes a specific CSM (Customer Service Management) attachment from ServiceNow using its sys_id.

Delete change taskPermanently deletes a specific task from a ServiceNow change request using its sys_id.

Delete ci lifecycle mgmt actionPermanently deletes a specific CI Lifecycle Management action from ServiceNow using its sys_id.

Delete ci lifecycle mgmt operatorsPermanently unregisters an operator from the ServiceNow CI Lifecycle Management system.

Delete cmdb instance relationPermanently deletes a specific CMDB CI (Configuration Item) relation using its sys_id.

Delete emergency change requestPermanently deletes a specific emergency change request from ServiceNow using its sys_id.

Delete incident byPermanently deletes a specific incident from ServiceNow using its sys_id.

Delete incident by id2Permanently deletes a specific incident from ServiceNow using its sys_id via the Table API.

Delete servicecatalog cartRemoves a specific item from the current ServiceNow Service Portal shopping cart.

Delete service catalog cart emptyEmpties all items from a specified Service Catalog shopping cart using its sys_id.

Delete sn chg rest changePermanently deletes a specific change request using its sys_id via the Change Management REST API.

Delete Normal Change RequestPermanently deletes a normal change request identified by its sys_id using the ServiceNow Change Management REST API.

Delete sn chg rest change standardPermanently deletes a standard change request from ServiceNow using its sys_id.

Delete tablePermanently deletes a specific record from a ServiceNow table using its sys_id.

Delete table incidentPermanently deletes a specific incident record from ServiceNow using its sys_id.

Find fileRetrieves attachment metadata from ServiceNow's sys_attachment table.

Get Activity Subscription ActivitiesRetrieves activity records from the ServiceNow ActivitySubscription API.

Get Activity Subscription FacetsRetrieves facets configured for an activity context in ServiceNow.

Get Agent Intelligence Solution PredictionPredicts an output field value using a trained Agent Intelligence solution model.

List Agent Intelligence Solution PredictionsRetrieves a list of solution predictions from ServiceNow's Agent Intelligence engine.

Get All Data ClassesRetrieves all data classification records from the ServiceNow Data Classification API.

Get App Service CMDB ContentRetrieves a list of configuration items (CIs) associated with a specific application service in ServiceNow CMDB.

Get attachment byRetrieves metadata for a specific attachment by its sys_id from ServiceNow.

Get Attachment by IDRetrieves metadata for a specific attachment by its sys_id from ServiceNow.

Get attachment fileDownloads the binary file attachment with the specified sys_id from ServiceNow.

Get attachment file fileDownloads the binary file attachment with the specified sys_id from ServiceNow using the v1 API endpoint.

Get Attachment ListRetrieves metadata for multiple file attachments from ServiceNow's Attachment API.

Get change ci scheduleRetrieves available time slots for scheduling changes against a specific Configuration Item (CI).

Get Change Conflict StatusRetrieves the conflict status for a ServiceNow change request, identifying scheduling conflicts with other changes or blackout windows.

Get change nextstatesRetrieves a list of available next states for a specified change request based on the current state and workflow.

Get Change Request Configuration ItemsRetrieves configuration items (CIs) associated with a specific change request in ServiceNow.

Get change scheduleRetrieves available time slots for scheduling a ServiceNow change request.

Get CI Lifecycle Management ActionRetrieves a specific CI Lifecycle Management action from ServiceNow using its sys_id.

Check CI CompatibilityDetermines whether two specified Configuration Items (CIs) in the ServiceNow CMDB are compatible using the CI Lifecycle Management compatActions endpoint.

Check CI Lease Expiration StatusDetermines whether a CI Lifecycle Management lease has expired for the specified lease record.

Check CI Not Allowed Ops TransitionDetermines whether a configuration item (CI) can be transitioned based on CI lifecycle management rules.

Validate CI Lifecycle Management RequestorValidates whether a specified active workflow requestor exists and is valid in ServiceNow CI Lifecycle Management.

Get CI Lifecycle Mgmt StatusRetrieves the current operational status for a Configuration Item (CI) in ServiceNow CMDB using the CI Lifecycle Management API.

Get CMDB Linux Server by IDRetrieves a single CMDB Linux server configuration item (CI) by its sys_id, including its attributes and relationship information.

Find CSDM Application ServiceFinds and returns basic information about one or more application services in the ServiceNow CMDB using the CSDM (Common Service Data Model) app_service find_service endpoint.

Get CMDB Instance by ClassRetrieves configuration items (CIs) from a specified CMDB class using the ServiceNow CMDB Instance API.

Get CMDB Instance by IDRetrieves a single CMDB configuration item (CI) by its class name and sys_id, including its attributes and relationship information.

Get CMDB Class MetadataRetrieves metadata and schema information for a specified CMDB (Configuration Management Database) class.

Get Cloud Catalog ServicesRetrieves a list of catalog items from the ServiceNow Cloud Services Catalog API.

Get Email by IDRetrieves a specific email record from ServiceNow's Email [sys_email] table by its sys_id.

Get Global User Role InheritanceRetrieves the granted and inherited roles for a specified ServiceNow user using the Global User Role Inheritance API.

Get importRetrieves the specified import staging record and its associated target records.

Get incident byRetrieves a specific incident from ServiceNow by its sys_id.

Get incident by id2Retrieves a specific incident from ServiceNow by its sys_id using the Table API.

Get IncidentsRetrieves incidents from the ServiceNow incident table using the Table API.

Get Performance Analytics ScorecardsRetrieves details about indicators from the Analytics Hub, including scorecard information for performance analytics.

Get recordsRetrieves multiple records from a specified ServiceNow table with optional filtering and pagination.

Get Record TypesRetrieves all available table record types from the ServiceNow instance using the Table API documentation endpoint.

Get Rows from TableRetrieves records from a specified ServiceNow table using the Table API v2.

Get servicatalog items byRetrieves a specific Service Catalog item from ServiceNow using its sys_id.

Get Catalog Item VariablesRetrieves the list of variables defined for a ServiceNow Service Catalog item.

Get Service Catalog CartRetrieves the details of all items within the logged-in user's Service Catalog shopping cart.

Get Service Catalog Cart Delivery AddressRetrieves the delivery/shipping address configured for a user's Service Catalog shopping cart.

Get Service Catalog Catalog by IDRetrieves the available information for a specified service catalog by its sys_id.

Get Service Catalog Catalog CategoriesRetrieves the list of available categories for a specified ServiceNow Service Catalog.

Get Service Catalog Category by IDRetrieves the available information for a specified service catalog category by its sys_id.

Get Service Catalog Item DelegationVerifies whether a delegated user has access to a specific ServiceNow Service Catalog item.

Get Service Catalog Items ListRetrieves a list of catalog items from ServiceNow's Service Catalog API.

Get Service Catalog Wishlist ListRetrieves the list of items in the logged-in user's ServiceNow Service Catalog wishlist.

Get sn cdm shared libraries upload statusRetrieves the current status of a shared library upload operation in ServiceNow.

Get sn chg rest change byRetrieves a specific change request from ServiceNow using its sys_id.

Get sn chg rest change emergency byRetrieves a specific emergency change request from ServiceNow using its sys_id.

Get sn chg rest change emergency listRetrieves one or more emergency change requests from ServiceNow using the Change Management API.

List ServiceNow Change RequestsRetrieves one or more change requests from ServiceNow based on specified filter criteria.

Get sn chg rest change model byRetrieves a specific change model from ServiceNow using its sys_id.

Get sn chg rest change model listRetrieves one or more change models from ServiceNow's Change Management API.

Get Normal Change Request by IDRetrieves a specific normal change request from ServiceNow using its sys_id via the Change Management REST API.

List ServiceNow Normal Change RequestsRetrieves one or more normal change requests from ServiceNow's Change Management API.

Get sn chg rest change standard byRetrieves a specific standard change request from ServiceNow using its sys_id.

Get sn chg rest change standard listRetrieves one or more standard change requests from ServiceNow using the Change Management API.

Get ServiceNow Standard Change Template by IDRetrieves a specific standard change template from ServiceNow using its sys_id.

List ServiceNow Standard Change TemplatesRetrieves one or more standard change templates from ServiceNow's Change Management API.

Get Change TasksRetrieves one or more tasks associated with a specific ServiceNow change request.

Get sn cicd app batch resultsRetrieves the results of a batch application install operation from ServiceNow CI/CD.

Get Instance Scan ResultRetrieves the current progress and status of a CI/CD instance scan operation in ServiceNow.

Get CI/CD ProgressRetrieves the current progress and status of a CI/CD operation in ServiceNow.

Get sn cicd testsuite resultsRetrieves the results of a test suite run from ServiceNow CI/CD based on the result ID.

Get statsRetrieves aggregate statistics for a specified ServiceNow table, including COUNT, AVG, MIN, MAX, and SUM calculations.

Get Table Records by IDRetrieves multiple records from a specified ServiceNow table using the Table API.

Get Table Record by IDRetrieves the record identified by the specified sys_id from the specified table.

Get table incident byRetrieves a single incident record from ServiceNow by its sys_id using the Table API.

List ServiceNow IncidentsRetrieves one or more incident records from the ServiceNow incident table using the Table API.

Get ServiceNow TablesRetrieves one or more records from a ServiceNow table using the Table API (GET /api/now/v2/table).

Get userRetrieves a specific user record from ServiceNow using its sys_id.

Get usersRetrieves multiple user records from the ServiceNow sys_user table with optional filtering and pagination.

List ServiceNow AttachmentsRetrieves metadata for multiple file attachments from ServiceNow's Attachment API.

List CMDB Linux ServersRetrieves Linux server configuration items (CIs) from the ServiceNow CMDB using the cmdb_ci_linux_server class.

List CMDB Configuration ItemsRetrieves configuration items (CIs) from the ServiceNow CMDB using the base cmdb_ci class.

List CMDB Relationship TypesRetrieves CMDB relationship types from the ServiceNow cmdb_rel_type table using the Table API.

List Service Catalog CatalogsRetrieves a list of ServiceNow Service Catalog catalogs to which the user has access.

Refresh Impacted Services for ChangeRefreshes and repopulates the impacted services/configuration items for a change request in ServiceNow using the Change Management REST API.

Retrieve sn cicd update setRetrieves an update set with a given sys_id from the ServiceNow CICD (Continuous Integration/Continuous Delivery) plugin.

Schedule change first availableUpdates the planned start and end times of a ServiceNow change request to the first available schedule slot.

Update cmdb csdm app service populate servicePopulates an Application Service with CI (Configuration Item) relationships based on the CSDM (Common Service Data Model) model.

Update CMDB CSDM App Service Service DetailsUpdates the service details for a specific application service in the CMDB CSDM (Common Service Data Model).

Update cmdb instance byUpdates an existing configuration item (CI) record in the ServiceNow CMDB by its sys_id.

Update CMDB Instance by IDUpdates an existing Configuration Item (CI) instance in the ServiceNow CMDB.

Update conversation member dropDrops an agent from a conversation in ServiceNow using the Conversation Member API.

Update incident byUpdates an existing incident in ServiceNow identified by its sys_id using the Table API.

Update incident by id2Updates an existing incident record in ServiceNow using the Table API.

Update openframe voice interactionUpdates an existing voice interaction record in ServiceNow OpenFrame.

Update servicecatalog cartUpdates an existing item in the ServiceNow Service Portal shopping cart.

Update servicecatalog items submit guideSubmits an order guide in ServiceNow's Service Catalog with the specified variable values.

Update sn chg rest changeUpdates an existing change request in ServiceNow using the Change Management REST API.

Update sn chg rest change emergencyUpdates an existing emergency change request in ServiceNow using the Change Management API.

Update Normal Change RequestUpdates a normal change request identified by its sys_id using the ServiceNow Change Management REST API.

Update ServiceNow Standard Change RequestUpdates a standard change request in ServiceNow using its sys_id.

Update sn chg rest change taskUpdates an existing change request task in ServiceNow using the Change Management REST API.

Update SD-WAN Trouble TicketUpdates an existing trouble ticket in ServiceNow using the Service Operations Workspace Trouble Ticket Open API.

Update Trouble TicketUpdates an existing trouble ticket in ServiceNow using the Trouble Ticket Open API.

Update table byUpdates an existing record in a specified ServiceNow table by its sys_id using the Table API.

Update table by id2Updates an existing record in a specified ServiceNow table using its sys_id with the provided field values.

Update table incidentUpdates an existing incident record in ServiceNow using the Table API.

Update table recordUpdates an existing record in a specified ServiceNow table using the Table API.

Upload Attachment to ServiceNow RecordUploads a file as an attachment to a specified record in ServiceNow.

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:

Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
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 { 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: ["servicenow"],
  });

  const mcpUrl = session.mcp.url;

What's happening:

We're creating a Tool Router session that gives your agent access to ServiceNow 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 ServiceNow-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 ServiceNow 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 servicenow, 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 ServiceNow 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 ServiceNow 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: ["servicenow"],
  });

  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 servicenow, 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 ServiceNow 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 ServiceNow MCP Agent with another framework

ChatGPT

Use ServiceNow MCP with ChatGPT

Antigravity

Use ServiceNow MCP with Antigravity

OpenAI Agents SDK

Use ServiceNow MCP with OpenAI Agents SDK

Claude Agent SDK

Use ServiceNow MCP with Claude Agent SDK

Claude Code

Use ServiceNow MCP with Claude Code

Claude Cowork

Use ServiceNow MCP with Claude Cowork

Codex

Use ServiceNow MCP with Codex

Cursor

Use ServiceNow MCP with Cursor

OpenClaw

Use ServiceNow MCP with OpenClaw

Hermes

Use ServiceNow MCP with Hermes

CLI

Use ServiceNow MCP with CLI

Google ADK

Use ServiceNow MCP with Google ADK

LangChain

Use ServiceNow MCP with LangChain

Mastra AI

Use ServiceNow MCP with Mastra AI

LlamaIndex

Use ServiceNow MCP with LlamaIndex

CrewAI

Use ServiceNow MCP with CrewAI

OpenCode

Use ServiceNow MCP with OpenCode

VS Code

Use ServiceNow MCP with VS Code

Explore Other Toolkits

Google Sheets

Oauth2

Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.

Notion

Oauth2Api Key

Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.

Airtable

Oauth2Api Key

Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.

TOOLKIT MARKETPLACE

FAQ

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

With a standalone ServiceNow MCP server, the agents and LLMs can only access a fixed set of ServiceNow tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from ServiceNow 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 v6?

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

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

Yes, absolutely. You can configure which ServiceNow 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 ServiceNow data and credentials are handled as safely as possible.

Used by agents from

Never worry about agent reliability

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

Get started for free Get a demo↗

Harsha GaddipatiCo-founder, Slashy

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

Abhi AryaCo-founder, Opennote

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 has immensely helped in keeping new users on the platform.

Nirman DaveCEO, Zams

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

Ryan YuFounder, Extra Thursday

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

Tomisin JenrolaFounder & CEO, SwarmZero

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

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

Harsha GaddipatiCo-founder, Slashy

Abhi AryaCo-founder, Opennote

Nirman DaveCEO, Zams

Ryan YuFounder, Extra Thursday

Tomisin JenrolaFounder & CEO, SwarmZero

Jerome LeclancheCo-Founder, Ingram Technologies

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.

How to integrate ServiceNow MCP with Vercel AI SDK v6

Table of Contents

Connect ServiceNow without Auth hassles

Introduction

Also integrate ServiceNow with

TL;DR

What is Vercel AI SDK?

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

Supported Tools & Triggers

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

What is Composio SDK?

How the Composio SDK works

Step-by-step Guide

Prerequisites

Getting API Keys for OpenAI and Composio

Install required dependencies

Set up environment variables

Import required modules and validate environment

Create Tool Router session and initialize MCP client

Connect to MCP server and retrieve tools

Initialize conversation and CLI interface

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

Complete Code

Conclusion

How to build ServiceNow MCP Agent with another framework

ChatGPT

Antigravity

OpenAI Agents SDK

Claude Agent SDK

Claude Code

Claude Cowork

Codex

Cursor

OpenClaw

Hermes

CLI

Google ADK

LangChain

Mastra AI

LlamaIndex

CrewAI

OpenCode

VS Code

Explore Other Toolkits

Google Sheets

Notion

Airtable

FAQ

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

Can I use Tool Router MCP with Vercel AI SDK v6?

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

How safe is my data with Composio Tool Router?

Used by agents from

Never worry about agent reliability