📋 Table of Contents
Shinzo Platform provides comprehensive observability for MCP servers, offering:
- MCP-Native Observability: Purpose-built monitoring for MCP tools, resources, and prompts
- OpenTelemetry Compatibility: Industry-standard telemetry with MCP-specific insights
- Zero-Configuration Instrumentation: Get started in minutes with our SDKs
- Privacy-First Design: Built-in PII sanitization and configurable data processing
The documentation is organized into the following sections:
- Quick Start Guide - Get your MCP server instrumented in under 5 minutes
- Model Context Protocol (MCP) - Understanding MCP and why observability matters for MCP developers
- OpenTelemetry - How Shinzo leverages OpenTelemetry standards
- Dashboard - Guide to using the Shinzo Platform web dashboard
- Installation - Installing and setting up the TypeScript SDK
- Configuration - Advanced configuration options for TypeScript
- Installation - Installing and setting up the Python SDK
- Configuration - Advanced configuration options for Python
- Node.js 20 LTS or 22 LTS (Node 25+ is not supported)
- npm, pnpm, or yarn
Install the Mintlify CLI globally:
npm i -g mintNavigate to the docs directory and start the development server:
mint devYour local preview will be available at http://localhost:3000.
To run Mintlify on a specific port:
mint dev --port 3333If a port is already in use, Mintlify will automatically use the next available port.
Check for broken links in the documentation:
mint broken-linksUpdate to the latest Mintlify CLI version:
npm i -g mint@latestWe welcome contributions to improve the Shinzo Platform documentation! Here's how you can help:
If you find errors, broken links, or unclear explanations:
- Check existing issues to avoid duplicates
- Open a new issue with a clear description of the problem
- Include the page URL and suggested improvements
- Fork the repository and create a new branch for your changes
- Make your edits following our writing standards (see below)
- Test locally using
mint devto preview your changes - Validate that all links work using
mint broken-links - Submit a pull request with a clear description of your changes
When contributing documentation:
- Voice: Use passive voice for direct, clear instructions (avoid "you" and "your")
- Prerequisites: List prerequisites at the start of procedural content
- Code examples: Test all code examples before submitting
- Formatting: Match the style and formatting of existing pages
- Language tags: Include language tags on all code blocks
- Alt text: Add descriptive alt text to all images
- Links: Use relative paths for internal links (e.g.,
/quickstartnothttps://docs.shinzo.ai/quickstart)
Every MDX file must include frontmatter with:
---
title: "Clear, descriptive page title"
description: "Concise summary for SEO and navigation"
---- Document just enough for user success - avoid over-explaining
- Prioritize accuracy and usability
- Make content evergreen when possible
- Search for existing information before adding new content
- Check existing patterns for consistency
- Start by making the smallest reasonable changes
Changes to the documentation are automatically deployed to production when merged to the main branch through our GitHub integration.
Error: "mint dev is not supported on node versions 25+"
- Mintlify CLI doesn't support Node.js 25+ due to breaking changes in the Web Storage API
- Install Node.js 22 LTS via Homebrew:
brew install node@22 - Run with Node 22:
PATH="/opt/homebrew/opt/node@22/bin:$PATH" mint dev
Error: Could not load the "sharp" module
- This may indicate an outdated Node.js version
- Remove the CLI:
npm remove -g mint - Upgrade to Node 20 or 22 LTS
- Reinstall:
npm i -g mint
Unknown errors
- Delete the
~/.mintlifyfolder from your home directory - Run
mint devagain
Make sure you're using relative paths for internal links:
- ✅ Good:
/quickstart - ❌ Bad:
https://docs.shinzo.ai/quickstart
This documentation is maintained by Shinzo Labs under the MIT License.