Skip to main content

Using the TypeScript SDK

The Shinzo TypeScript SDK provides automatic instrumentation for MCP servers built with the @modelcontextprotocol/sdk. Get started with comprehensive telemetry in just a few minutes.
Building with Python? Check out the Python SDK for Python MCP server instrumentation.

Requirements

Package Installation

Install the Shinzo instrumentation SDK using your preferred package manager:

Peer Dependencies

The SDK requires the MCP SDK as a peer dependency. If you haven’t already installed it:

Basic Setup

Once installed, instrument your MCP server with just a few lines of code:
If your server does not call tools as above, please contact austin@shinzolabs.com so we can prioritize your method of calling server tools.

Environment Variables

For better security and configuration management, consider using environment variables:

Verification

1. Test with Console Exporter

For development, use the console exporter to see telemetry locally:

2. Execute a Tool

Run your server and execute any tool. You should see telemetry data in:
  • Console output (if using console exporter)
  • Shinzo Platform dashboard (if using HTTP exporter)

Troubleshooting Installation

Module Resolution Issues

If you encounter module resolution errors:
  1. Check Node.js version: Ensure you’re using Node.js 18+.
  2. Update dependencies: Run npm update to get latest versions.

Type Errors

For TypeScript type errors:
  1. Install type definitions: npm install @types/node.
  2. Update TypeScript: Ensure you’re using TypeScript 4.5+.
  3. Check imports: You may need to use .js extensions in import paths, depending on your build setup.

Network Issues

If telemetry isn’t reaching the Shinzo Platform:
  1. Check firewall: Ensure outbound HTTPS connections are allowed.
  2. Verify endpoint: Confirm the endpoint URL is correct.
  3. Test connectivity: Try curl https://api.app.shinzo.ai/health.

Next Steps

Now that you have the SDK installed:

Configuration

Learn about all available configuration options.
Need help? Contact us at austin@shinzolabs.com or check our GitHub repository.