# NitroStack Documentation

> NitroStack MCP framework docs. TypeScript SDK + CLI and Python SDK + CLI (nitrostack / nitrostack-py).
> Prefer the .md URL for each page when ingesting into an LLM.

Site: https://docs.nitrostack.ai

## Agent skills

Install NitroStack agent skills (`SKILL.md`) into Cursor, Claude Code, Codex, Gemini CLI, Copilot, OpenCode, and other agents.
Preferred installer: the skills CLI (`npx skills add <owner/repo>`). `init` also clones the same registries into project agent folders.
- TypeScript registry: https://github.com/nitrocloudofficial/skills
- TypeScript install: `npx skills add nitrocloudofficial/skills`
- TypeScript via CLI: `npx @nitrostack/cli init` copies skills into `.cursor/skills`, `.claude/skills`, `.codex/skills`, `.gemini/skills`, `.copilot/skills`, `.opencode/skills`, and `.agents/skills`.
- Python registry: https://github.com/nitrocloudofficial/skills-python-sdk
- Python install: `npx skills add nitrocloudofficial/skills-python-sdk`
- Python via CLI: `nitrostack-py init` copies skills into the same agent folders. `nitrostack-py upgrade` refreshes them when the registry version bumps.

- [TypeScript SDK](https://docs.nitrostack.ai/llms.txt#typescript)
- [Python SDK](https://docs.nitrostack.ai/llms.txt#python)
- [Python-only index](https://docs.nitrostack.ai/python/llms.txt)

## TypeScript

- [Introduction](https://docs.nitrostack.ai/intro.md): What is NitroStack, why use it, key features
- [Installation](https://docs.nitrostack.ai/installation.md): System requirements, installing globally and locally
- [Quickstart](https://docs.nitrostack.ai/quick-start.md): Build and run your first MCP server in 10 minutes
- [Quickstart](https://docs.nitrostack.ai/getting-started/quickstart.md): Build and run your first MCP server in 10 minutes
- [MCP Basics](https://docs.nitrostack.ai/getting-started/mcp-basics.md): Tools, resources, prompts and protocol primitives
- [Connect Your Coding Agent](https://docs.nitrostack.ai/getting-started/connect-your-coding-agent.md): Agent skills and rules for Cursor, Claude Code, and Copilot
- [Connect to Clients](https://docs.nitrostack.ai/getting-started/connect-to-clients.md): Connect Claude Desktop, Cursor, and VS Code
- [CLI Overview](https://docs.nitrostack.ai/cli/overview.md): Command-line interface overview and commands
- [Init Command](https://docs.nitrostack.ai/cli/init.md): Create new projects with templates
- [Dev Command](https://docs.nitrostack.ai/cli/dev.md): Development server with hot reload
- [Build Command](https://docs.nitrostack.ai/cli/build.md): Production builds and optimization
- [Configuration](https://docs.nitrostack.ai/cli/configuration.md): CLI and project configuration options
- [Install Command](https://docs.nitrostack.ai/cli/install.md): Install project dependencies
- [Generate Command](https://docs.nitrostack.ai/cli/generate.md): Generate modules, tools, and more
- [Upgrade Command](https://docs.nitrostack.ai/cli/upgrade.md): Upgrade NitroStack packages
- [Start Command](https://docs.nitrostack.ai/cli/start.md): Start the production server
- [Cursor Command](https://docs.nitrostack.ai/cli/cursor.md): Integrate MCP server with Cursor
- [Pack Command](https://docs.nitrostack.ai/cli/pack.md): Create an optimized deployment zip
- [Server Concepts](https://docs.nitrostack.ai/sdk/typescript/server.md): Server creation, configuration, and lifecycle
- [Tools](https://docs.nitrostack.ai/sdk/typescript/tools.md): Creating tools with input schemas and handlers
- [Resources](https://docs.nitrostack.ai/sdk/typescript/resources.md): Creating resources with URI schemes
- [Prompts](https://docs.nitrostack.ai/sdk/typescript/prompts.md): Creating prompts and templates
- [Guards](https://docs.nitrostack.ai/sdk/typescript/guards.md): Request authorization, canActivate, and guard pipeline
- [Middleware](https://docs.nitrostack.ai/sdk/typescript/middleware.md): Request processing and authentication middleware
- [Interceptors](https://docs.nitrostack.ai/sdk/typescript/interceptors.md): Around-invoke interceptors for tools
- [Pipes](https://docs.nitrostack.ai/sdk/typescript/pipes.md): Transform and validate tool input
- [Validation](https://docs.nitrostack.ai/sdk/typescript/validation.md): Zod schemas and runtime validation
- [Dependency Injection](https://docs.nitrostack.ai/sdk/typescript/dependency-injection.md): Constructor injection and modules
- [Configuration](https://docs.nitrostack.ai/sdk/typescript/configuration.md): Type-safe configuration with ConfigModule and ConfigService
- [Caching](https://docs.nitrostack.ai/sdk/typescript/caching.md): Cache decorator and TTL
- [Rate Limiting](https://docs.nitrostack.ai/sdk/typescript/rate-limiting.md): Rate limit decorator
- [Health Checks](https://docs.nitrostack.ai/sdk/typescript/health-checks.md): Server monitoring, @HealthCheck decorator, and health://checks resource
- [MCP Tasks](https://docs.nitrostack.ai/sdk/typescript/tasks.md): Long-running MCP tasks
- [Transforms Pipeline](https://docs.nitrostack.ai/sdk/typescript/transforms.md): BM25 progressive tool discovery and Code Mode WASM sandboxing
- [Data Spillover](https://docs.nitrostack.ai/sdk/typescript/data-spillover.md): Handling large tool outputs with automatic preview and resource spilling
- [Authentication Overview](https://docs.nitrostack.ai/sdk/typescript/auth/overview.md): Authentication types and security best practices
- [API Key Auth](https://docs.nitrostack.ai/sdk/typescript/auth/api-key.md): Simple API key authentication
- [OAuth 2.1](https://docs.nitrostack.ai/sdk/typescript/auth/oauth.md): OAuth 2.1 with PKCE implementation
- [Error Handling](https://docs.nitrostack.ai/sdk/typescript/error-handling.md): Error classes, try-catch patterns, logging
- [Testing](https://docs.nitrostack.ai/sdk/typescript/testing.md): Unit and integration testing strategies
- [Events](https://docs.nitrostack.ai/sdk/typescript/events.md): Event emitter and listeners
- [UI Widgets](https://docs.nitrostack.ai/sdk/typescript/ui/widgets.md): Build widgets with Next.js and Tailwind
- [Widget Manifest](https://docs.nitrostack.ai/sdk/typescript/ui/widget-manifest.md): Widget manifest format
- [Widget SDK Reference](https://docs.nitrostack.ai/sdk/typescript/ui/widget-sdk.md): React widget SDK APIs
- [Best Practices](https://docs.nitrostack.ai/sdk/typescript/best-practices.md): Production patterns for MCP servers
- [Performance](https://docs.nitrostack.ai/sdk/typescript/performance.md): Performance tuning
- [File Uploads](https://docs.nitrostack.ai/sdk/typescript/file-uploads.md): Handle file uploads in tools
- [Studio Overview](https://docs.nitrostack.ai/studio/overview.md): Visual testing environment for MCP servers
- [Testing Tools](https://docs.nitrostack.ai/studio/testing.md): Manual testing and widget previews
- [Chat Interface](https://docs.nitrostack.ai/studio/chat.md): LLM-powered testing
- [Standalone Setup](https://docs.nitrostack.ai/studio/standalone.md): Run Studio independently
- [Dual Transport](https://docs.nitrostack.ai/guides/dual-transport.md): stdio and HTTP together
- [Streamable HTTP & SSE](https://docs.nitrostack.ai/guides/streamable-http.md): Streamable HTTP and legacy SSE endpoints
- [Widget CSP](https://docs.nitrostack.ai/guides/widget-csp.md): Content Security Policy for hosted widgets
- [Verify Transport](https://docs.nitrostack.ai/guides/verify-transport.md): Debug MCP transport issues
- [Widget SDK Migration](https://docs.nitrostack.ai/guides/widget-sdk-migration.md): Migrate widget SDK versions
- [Widget Examples](https://docs.nitrostack.ai/guides/widget-examples.md): Widget example gallery
- [Starter Template](https://docs.nitrostack.ai/templates/starter.md): Simple calculator template
- [OAuth 2.1 Template](https://docs.nitrostack.ai/templates/oauth.md): Flight booking with OAuth
- [Pizzaz Template](https://docs.nitrostack.ai/templates/pizzaz.md): Pizza shop finder with widgets
- [Enterprise Search Template](https://docs.nitrostack.ai/templates/enterprise-search.md): BM25 progressive search template for large tool catalogs
- [Code Mode Template](https://docs.nitrostack.ai/templates/code-mode.md): Sandboxed QuickJS WebAssembly code execution template
- [Production Checklist](https://docs.nitrostack.ai/deployment/checklist.md): Pre-deployment verification
- [Docker](https://docs.nitrostack.ai/deployment/docker.md): Containerization and Docker Compose
- [Cloud Platforms](https://docs.nitrostack.ai/deployment/cloud.md): Deploy to AWS, GCP, Azure, and more
- [Decorators](https://docs.nitrostack.ai/api/decorators.md): Decorator API reference
- [Guards](https://docs.nitrostack.ai/api/guards.md): Guard API reference
- [Middleware API](https://docs.nitrostack.ai/api/middleware.md): Middleware API reference
- [Interceptors API](https://docs.nitrostack.ai/api/interceptors.md): Interceptor API reference
- [Pipes API](https://docs.nitrostack.ai/api/pipes.md): Pipe API reference
- [Execution Context](https://docs.nitrostack.ai/api/execution-context.md): ExecutionContext API
- [CLI Commands](https://docs.nitrostack.ai/api/cli-commands.md): CLI command reference
- [SDK Quick Reference](https://docs.nitrostack.ai/ai-agents/sdk-reference.md): Dense SDK reference for coding agents
- [CLI Quick Reference](https://docs.nitrostack.ai/ai-agents/cli-reference.md): Dense CLI reference for coding agents
- [Documentation Index](https://docs.nitrostack.ai/documentation-index.md): Complete list of all documentation pages

## Python

- [Python home](https://docs.nitrostack.ai/python)
- [Introduction](https://docs.nitrostack.ai/python/intro.md): Python SDK overview: modules, DI, Pydantic, nitrostack-py
- [Installation](https://docs.nitrostack.ai/python/installation.md): pip install nitrostack, Python 3.10+, uv-first projects
- [Quick Start](https://docs.nitrostack.ai/python/quick-start.md): Scaffold and run your first Python MCP server
- [CLI Overview](https://docs.nitrostack.ai/python/cli/overview.md): nitrostack-py commands and project lifecycle
- [CLI Installation](https://docs.nitrostack.ai/python/cli/installation.md): Install nitrostack-py with pip or uv
- [Init Command](https://docs.nitrostack.ai/python/cli/init.md): Scaffold python-starter, pizzaz, or oauth templates
- [Dev Command](https://docs.nitrostack.ai/python/cli/dev.md): Hot-reload development server
- [Start Command](https://docs.nitrostack.ai/python/cli/start.md): Production server without reload
- [Pack Command](https://docs.nitrostack.ai/python/cli/pack.md): Build a deployable wheel (never includes .env)
- [Install Command](https://docs.nitrostack.ai/python/cli/install.md): uv sync or pip install project dependencies
- [Generate Command](https://docs.nitrostack.ai/python/cli/generate.md): Generate tools, modules, guards, pipes, services
- [Upgrade Command](https://docs.nitrostack.ai/python/cli/upgrade.md): Bump nitrostack and refresh agent skills
- [Validate Command](https://docs.nitrostack.ai/python/cli/validate.md): Lint deps, @mcp_app imports, and @module refs
- [Register Command](https://docs.nitrostack.ai/python/cli/register.md): Register the server with Claude Desktop
- [Configuration](https://docs.nitrostack.ai/python/cli/configuration.md): .env, ServerConfig, and transport settings
- [Server Concepts](https://docs.nitrostack.ai/python/sdk/server.md): McpApplicationFactory, @module, DI, ConfigModule
- [Tools](https://docs.nitrostack.ai/python/sdk/tools.md): @tool with Pydantic input_schema and ExecutionContext
- [Resources](https://docs.nitrostack.ai/python/sdk/resources.md): @resource URIs and mime types
- [Prompts](https://docs.nitrostack.ai/python/sdk/prompts.md): @prompt with PromptArgument
- [Middleware](https://docs.nitrostack.ai/python/sdk/middleware.md): use_middleware protocol and stacking
- [Interceptors](https://docs.nitrostack.ai/python/sdk/interceptors.md): use_interceptors around tool execution
- [Authentication Overview](https://docs.nitrostack.ai/python/sdk/auth/overview.md): API keys, JWT, OAuth 2.1 modules
- [API Key Auth](https://docs.nitrostack.ai/python/sdk/auth/api-key.md): ApiKeyModule and ApiKeyGuard
- [OAuth 2.1](https://docs.nitrostack.ai/python/sdk/auth/oauth.md): OAuthModule, OAuthGuard, scopes, OAUTH_REQUIRED
- [Pipes](https://docs.nitrostack.ai/python/sdk/pipes.md): use_pipes and transform protocol
- [Validation](https://docs.nitrostack.ai/python/sdk/validation.md): Pydantic models as input_schema
- [MCP Tasks](https://docs.nitrostack.ai/python/sdk/tasks.md): task_support and context.task.update_progress
- [Dependency Injection](https://docs.nitrostack.ai/python/sdk/dependency-injection.md): @injectable(deps=[...]) constructor injection
- [Error Handling](https://docs.nitrostack.ai/python/sdk/error-handling.md): SDK errors and use_filters
- [Testing](https://docs.nitrostack.ai/python/sdk/testing.md): NitroTestingModule in-process harness
- [Events](https://docs.nitrostack.ai/python/sdk/events.md): @on_event and EventEmitter
- [UI Widgets](https://docs.nitrostack.ai/python/sdk/widgets.md): Static HTML widgets under widgets/out
- [Best Practices](https://docs.nitrostack.ai/python/sdk/best-practices.md): Python-idiomatic NitroStack patterns
- [Caching](https://docs.nitrostack.ai/python/sdk/caching.md): @cache(ttl=...) decorator
- [Rate Limiting](https://docs.nitrostack.ai/python/sdk/rate-limiting.md): @rate_limit decorator
- [Performance](https://docs.nitrostack.ai/python/sdk/performance.md): Sessions, transports, and logging
- [API Keys Guide](https://docs.nitrostack.ai/python/sdk/api-keys.md): API key module deep dive
- [OAuth 2.1 Guide](https://docs.nitrostack.ai/python/sdk/oauth-2.1.md): JWKS, introspection, PKCE, CIMD
- [Studio Overview](https://docs.nitrostack.ai/python/studio/overview.md): Test Python servers via HTTP Inspector, not folder-connect
- [Testing Tools](https://docs.nitrostack.ai/python/studio/testing.md): Inspector HTTP and widgets preview
- [Chat Interface](https://docs.nitrostack.ai/python/studio/chat.md): Chat against a Python MCP HTTP server
- [Standalone Setup](https://docs.nitrostack.ai/python/studio/standalone.md): Point Studio at a custom Streamable HTTP URL
- [Dual Transport](https://docs.nitrostack.ai/python/guides/dual-transport.md): MCP_TRANSPORT_TYPE stdio, http, dual
- [Verify Transport](https://docs.nitrostack.ai/python/guides/verify-transport.md): Debug Python MCP HTTP and stdio
- [Starter Template](https://docs.nitrostack.ai/python/templates/starter.md): python-starter calculator + widget
- [OAuth 2.1 Template](https://docs.nitrostack.ai/python/templates/oauth.md): python-oauth flight booking
- [Pizzaz Template](https://docs.nitrostack.ai/python/templates/pizzaz.md): python-pizzaz shops, map, and widgets
- [Production Checklist](https://docs.nitrostack.ai/python/deployment/checklist.md): Python production env, pack, start
- [Docker](https://docs.nitrostack.ai/python/deployment/docker.md): Containerize a Python NitroStack server
- [Cloud Platforms](https://docs.nitrostack.ai/python/deployment/cloud.md): Deploy nitrostack-py start to the cloud
- [Decorators](https://docs.nitrostack.ai/python/api/decorators.md): @tool, @module, @injectable, @mcp_app
- [Guards](https://docs.nitrostack.ai/python/api/guards.md): use_guards, ApiKeyGuard, JwtGuard, OAuthGuard
- [Middleware API](https://docs.nitrostack.ai/python/api/middleware.md): use_middleware protocol
- [Interceptors API](https://docs.nitrostack.ai/python/api/interceptors.md): use_interceptors protocol
- [Pipes API](https://docs.nitrostack.ai/python/api/pipes.md): use_pipes and PipeMetadata
- [Execution Context](https://docs.nitrostack.ai/python/api/execution-context.md): ExecutionContext, AuthContext, TaskContext
- [CLI Commands](https://docs.nitrostack.ai/python/api/cli-commands.md): nitrostack-py command reference
- [SDK Quick Reference](https://docs.nitrostack.ai/python/ai-agents/sdk-reference.md): Dense Python SDK reference for coding agents
- [CLI Quick Reference](https://docs.nitrostack.ai/python/ai-agents/cli-reference.md): Dense nitrostack-py reference for coding agents
- [Documentation Index](https://docs.nitrostack.ai/python/documentation-index.md): Python documentation index