Skip to main content
Your coding agent can do the setup for you with this prompt:

Supported MCP SDKs

For a new server, we recommend @modelcontextprotocol/server 2.x, because it implements the stateless MCP protocol of 2026-07-28. One agentcat package supports both, and track() finds the MCP SDK version by itself.

Installation

The SDK needs your project ID, which you can find in the AgentCat dashboard. We recommend the AGENTCAT_PROJECT_ID environment variable, which keeps the ID out of your code. The SDK does not read it by itself, so the snippets pass it to track().

Adding AgentCat to your server

agentcat.track() adds AgentCat to an McpServer, in the place where your code creates it:
A stateless server creates a new McpServer for each request (createMcpHandler) or each connection (serveStdio). Each track() call tracks one instance, so the call goes inside that factory, as the 2.x tab shows.

Identifying users

We strongly recommend that you identify your users. Without identity, the dashboard cannot show who uses your server, and each session stays anonymous.
The identify hook tells AgentCat which user made each tool call. We recommend the first of these two levels that your server can give. Full identity gives each session a real user ID and name, read from the request:

Anonymized identity (the minimum)

If you prefer not to send user details, a stable ID works too, for example a hash of the token or API key. The same user always gets the same ID:
With MCP auth, the checked token is in ctx.http.authInfo.token (2.x) or extra.authInfo.token (1.x). A stdio server has no HTTP headers, so the hook can read the key that your server already uses, for example from process.env. If the hook throws or takes more than 30 seconds, the event still goes out, without identity. Without an identify hook, AgentCat still works, but every user is anonymous. AgentCat turns on every feature by default, and we recommend that you keep them that way. Each one adds a different view of how agents use your server:
  • Intent (enableToolCallContext): agents tell you why they call each tool, which powers session goals.
  • Agent feedback (enableReportMissing): agents can report tools that they looked for and did not find, through the get_more_tools tool.
  • Sessions (enableTracing): AgentCat records each tool call and groups the calls of one task into one session, so you can replay it.
  • Diagnostics (disableDiagnostics turns it off): anonymous error reports help us fix a broken install faster.
If you need to turn one off, the reference page explains each option.

Testing your setup

The TypeScript SDK always writes its log to ~/agentcat.log, so it needs no debug option. The log shows the setup and each event that AgentCat sends.
  1. Watch the log:
  1. Start your real server with AGENTCAT_PROJECT_ID set, as you start it in production.
  2. Call one tool with an MCP client, for example the MCP Inspector CLI:
For a stdio server, you can replace the URL and --transport http with the command that starts your server, and leave out --header.
  1. Look for Successfully sent event ... | mcp:tools/call | ... in the log. The line ends with the user ID from identify, or anonymous. In Sessions, the new session shows the user name from identify.
A coding agent can confirm the event with the AgentCat MCP server. If no event arrives, the log shows whether track() worked and whether a send failed. On Cloudflare Workers, the log goes to the console instead.

Guidance for AI agents

  1. Keep identify in place, because without it every user is anonymous; if the developer does not want to send user details, offer the anonymized ID.
  2. Return the same ID for the same user on every call, because a random value or a timestamp splits one user into many.
  3. Keep raw tokens, API keys, and passwords out of userId, userName, and userData, because AgentCat stores and shows them.
  4. Leave enableToolCallContext, enableReportMissing, and enableTracing at their defaults, because each one feeds a part of the dashboard.
  5. Read the project ID from AGENTCAT_PROJECT_ID, so that it stays out of committed code.
  6. Call track() once per server instance, and inside the factory on a stateless server, because the factory makes a new instance each time.
  7. Run npm view agentcat version before you pin a version, because a version from memory can be old.
  8. Test through the real server start, because a separate script can skip the track() call.

Next steps

TypeScript reference

Options, runtimes, shutdown, and limits

Custom events

Send your own events

Tags and properties

Add data that you can filter on

Redaction

Remove sensitive data in your server

Exporters

Copies of events for OpenTelemetry, Datadog, Sentry, or PostHog