How to Use the Freshsuccess MCP in Pydantic AI

Q: How do I connect Pydantic AI to the Freshsuccess MCP Server?

Install the framework with MCP support and initialize the MCPToolset with your Vinkius HTTP endpoint. Pass this toolset into your Agent constructor to expose tools like listcsaccounts to your model.

Q: Does Pydantic AI validate the output of Freshsuccess health metrics?

Yes. Every response from tools like getaccounthealth or listcustommetrics is validated against Pydantic schemas at runtime. This prevents your agent from processing corrupted or unexpected JSON structures.

Q: Can I use Pydantic AI to write custom metrics back to Freshsuccess?

Yes. Your agent can collect usage statistics and use postmetricvalue to update your dashboard. The framework ensures the payload matches the expected schema before executing the tool.

Q: How do I test the connection to the server before running an agent?

Run a quick test where the agent calls checkapistatus. This returns the connection status, letting you confirm that your Vinkius credentials and network settings are correct before executing complex logic.

Build type-safe customer success agents with Pydantic AI and the Freshsuccess integration.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Freshsuccess MCP to Pydantic AI

Create your Vinkius account to connect Freshsuccess to Pydantic AI 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 Freshsuccess with Pydantic AI

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Type-safe customer success with Pydantic AI

Calling `get_account_health` and `get_user_health` with Pydantic AI ensures every single tool response is validated against strict Python types at runtime. When your agent fetches data, Pydantic AI validates the structure of the returned data. If the API returns unexpected fields, the framework catches it immediately. This prevents silent errors in your automation. Instead of your agent hallucinating data or failing silently when processing a customer's health score, you get a clear, actionable validation error that you can catch and handle in your code.

Strict validation for account creation

Executing `upsert_cs_account` or `upsert_cs_user` through this framework ensures your customer records are validated before they ever leave your environment. Writing data back to your customer success platform requires absolute precision. This keeps your records clean and free of formatting errors. The Pydantic AI framework integrates with the Freshsuccess MCP Server using the unified `MCPToolset` class. This setup supports both Streamable HTTP and SSE transports, allowing you to connect to your hosted Vinkius endpoint with a single line of code.

Reliable alert monitoring and task triage

Using `list_cs_alerts` allows you to build background scripts that monitor active alerts without risking runtime crashes. Your agent can pull data and process it using structured Pydantic models. This makes it easy to map alerts directly to internal classes in your codebase. Once an alert is parsed, the agent can use `list_cs_tasks` to check for existing follow-ups. If none exist, it can create a new task, ensuring that critical drops in customer usage are never ignored or lost in the shuffle.

Setup guide

Set up Freshsuccess MCP in Pydantic AI

Prerequisites

Python 3.10+ installed
pydantic-ai-slim[fastmcp] package
Active Vinkius subscription with a valid endpoint token

1

Install Pydantic AI with FastMCP
Run pip install "pydantic-ai-slim[fastmcp]". The FastMCP toolset replaces the deprecated MCPServerHTTP class with full protocol support.
2

Configure the FastMCPToolset
Pass a JSON-style config dict to FastMCPToolset with your Vinkius URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports Streamable HTTP, SSE, and Stdio transports.
3

Create and run your agent
Pass the toolset to Agent(toolsets=[toolset]) and call agent.run(). Swap openai:gpt-4o for any supported model — Anthropic, Google, Mistral, or Groq.

agent.py

from pydantic_ai import Agent
from pydantic_ai.toolsets.fastmcp import FastMCPToolset

toolset = FastMCPToolset({
    "mcpServers": {
        "freshsuccess-mcp": {
            "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
        }
    }
})

agent = Agent(
    "openai:gpt-4o",
    toolsets=[toolset],
    system_prompt="You have access to Freshsuccess tools.",
)

result = await agent.run("List recent Freshsuccess transactions")
print(result.output)

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 Freshsuccess. 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 Freshsuccess 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 Freshsuccess MCP in Pydantic AI

Install the framework with MCP support and initialize the `MCPToolset` with your Vinkius HTTP endpoint. Pass this toolset into your `Agent` constructor to expose tools like `list_cs_accounts` to your model.

Yes. Every response from tools like `get_account_health` or `list_custom_metrics` is validated against Pydantic schemas at runtime. This prevents your agent from processing corrupted or unexpected JSON structures.

Yes. Your agent can collect usage statistics and use `post_metric_value` to update your dashboard. The framework ensures the payload matches the expected schema before executing the tool.

Run a quick test where the agent calls `check_api_status`. This returns the connection status, letting you confirm that your Vinkius credentials and network settings are correct before executing complex logic.

Your data is processed inside Vinkius's isolated V8 sandbox environments. The MCP Server acts as a secure intermediary, transmitting only the validated tool outputs to your agent while keeping your master API keys and database credentials hidden from the LLM.

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