How to Use the ClientSuccess MCP in Vercel AI SDK

Q: How do I start using ClientSuccess with the Vercel AI SDK?

Just install the packages and point the createMCPClient function to the Vinkius URL we give you. You'll pass the tools from mcpClient.tools() into your streamText or generateText calls. It's a few lines of code.

Q: Is this just for read-only data?

No, you have write access too. The createclient tool lets your application add new clients to ClientSuccess. This is perfect for building internal tools or customer onboarding flows.

Build customer dashboards that pull live ClientSuccess data, right inside your app with the Vercel AI SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect ClientSuccess MCP to Vercel AI SDK

Create your Vinkius account to connect ClientSuccess to Vercel AI SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup ClientSuccess with Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Stream Client Data to Your UI

This isn't another loading spinner. Use the `get_client_details` and `list_clients` tools to stream customer information directly into your React or Next.js components. Your users see names, statuses, and segments appear in real time. You're not just fetching data; you're building a live view into your customer base. Hook up the `list_contacts` and `list_contracts` tools to show the right people and renewal dates for any client you display. It's fast, and it feels like part of your application.

Create Records without a Refresh

Let users add new customers directly from your interface. The `create_client` tool lets your agent create a new record in ClientSuccess instantly. No forms, no page reloads, no separate tabs. The Vercel AI SDK streams the result, so your UI can immediately update with the newly created client's ID and information. It's a clean, responsive way to handle data entry.

A ClientSuccess MCP Server for Frontends

This MCP Server was built for the kind of interactive apps you create with the Vercel AI SDK. It’s all about giving your front-end agent direct access to the data it needs to render. You get simple, focused tools that map directly to UI needs. `list_segments` populates a dropdown. `list_clients` fills a table. You don't have to build a separate backend API just to talk to ClientSuccess.

Setup guide

Set up ClientSuccess MCP in Vercel AI SDK

Prerequisites

Node.js 18+ and a TypeScript project
ai + @modelcontextprotocol/sdk packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies

Run npm install ai @modelcontextprotocol/sdk plus your preferred model provider (e.g. @ai-sdk/openai).
2

Create the Streamable HTTP transport

Use StreamableHTTPClientTransport with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and use tools

Call mcpClient.tools() to auto-discover all ClientSuccess tools. Pass them directly to generateText() or streamText() — no manual schema definitions needed.
4

Works with any model provider

Swap openai("gpt-4o") for any AI SDK provider — Anthropic, Google, Mistral. The MCP tools work identically across all supported models.

index.ts

import { experimental_createMCPClient as createMCPClient } from "ai";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

const transport = new StreamableHTTPClientTransport(
  new URL("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
);

const mcpClient = await createMCPClient({ transport });
const tools = await mcpClient.tools();

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "List recent ClientSuccess transactions",
});

console.log(text);
await mcpClient.close();

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by ClientSuccess. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect ClientSuccess now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about ClientSuccess MCP in Vercel AI SDK

Just install the packages and point the `createMCPClient` function to the Vinkius URL we give you. You'll pass the tools from `mcpClient.tools()` into your `streamText` or `generateText` calls. It's a few lines of code.

It's about user experience. Instead of waiting for a whole data set to load, your users see client lists, contacts, and details appearing on the screen as they're received. This makes your app feel much faster and more responsive.

Yes. The AI SDK's streaming protocol includes error handling. If a tool call to this MCP server fails, like with a bad client ID, your code gets an exception you can catch and display a proper error message in the UI.

No, you have write access too. The `create_client` tool lets your application add new clients to ClientSuccess. This is perfect for building internal tools or customer onboarding flows.

Your agent will be handling client names, contact information, and contract details. This MCP server connection is secured over HTTPS and requires your private Vinkius token for all operations. Data only moves between Vinkius and ClientSuccess when your agent makes a specific tool call.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript