# SlugKit

> SlugKit generates human-readable, collision-free identifiers from configurable patterns such as {adjective}-{noun}-{number:3d}. It offers a SaaS API and a self-hostable lite build, with deterministic series, slicing, forging, and URL shortening.

## mcp-help
- [Dictionary & Tag Reference (Agent Guide)](https://dev.slugkit.dev/docs/agent-dictionary-and-tag-reference)
- [Pattern Examples by Use Case (Agent Guide)](https://dev.slugkit.dev/docs/agent-pattern-examples)
- [Pattern Syntax Reference (Agent Guide)](https://dev.slugkit.dev/docs/agent-pattern-syntax-reference)
- [SlugKit Quick Start Guide (Agent Guide)](https://dev.slugkit.dev/docs/agent-quick-start-guide): Get started with SlugKit in 5 minutes for AI agents! Generate human-readable IDs, slugs, and structured content.

## developer-docs
- [API Authentication](https://dev.slugkit.dev/docs/api-authentication)
- [Error Handling](https://dev.slugkit.dev/docs/api-error-handling): Comprehensive guide to handling SlugKit API errors gracefully. Learn error response formats, retry strategies, debugging techniques, and production monitoring best practices.
- [Rate Limits & Quotas](https://dev.slugkit.dev/docs/api-rate-limits): Comprehensive guide to SlugKit's rate limiting system, subscription quotas, and best practices. Learn request limits, generation quotas, monitoring strategies, and upgrade recommendations.
- [URL Shortener API](https://dev.slugkit.dev/docs/api-url-shortener): Shorten arbitrary URLs into human-readable slugs and resolve them back. Covers the shorten, expand, and stats endpoints, required url: scopes, series binding, deduplication, storage caps, and retention.
- [Choosing Generation Methods](https://dev.slugkit.dev/docs/choosing-generation-method): Complete guide to choosing between forge, mint, and slice generation methods. Corrected decision tree and real-world examples for optimal SlugKit integration.
- [Core Concepts](https://dev.slugkit.dev/docs/developer-core-concepts): Master the fundamental concepts behind SlugKit: patterns, generation methods, uniqueness guarantees, and series management. Essential reading for effective SlugKit integration.
- [5-Minute Quickstart](https://dev.slugkit.dev/docs/developer-quickstart-guide)
- [Your First Slugs: Interactive Tutorial](https://dev.slugkit.dev/docs/developer-tutorial): Hands-on tutorial with step-by-step exercises to master SlugKit pattern creation. Learn through practical examples: blog URLs, gaming handles, API endpoints, and infrastructure naming.
- [Content Management](https://dev.slugkit.dev/docs/example-content-management)
- [E-commerce Platform](https://dev.slugkit.dev/docs/example-ecommerce-platform)
- [Gaming Usernames](https://dev.slugkit.dev/docs/example-gaming-usernames)
- [Microservices Naming](https://dev.slugkit.dev/docs/example-microservices-naming)
- [DevOps & Infrastructure Naming Guide](https://dev.slugkit.dev/docs/guide-devops-infrastructure): Comprehensive guide for naming servers, containers, configurations, and infrastructure resources. Focuses on naming strategies, organizational patterns, and operational best practices for DevOps teams.
- [User Handles & Social Integration Guide](https://dev.slugkit.dev/docs/guide-user-handles): Pattern design guide for memorable user handles and social identifiers. Focuses on design principles, platform constraints, and user experience best practices rather than implementation details.
- [Web Development Integration Guide](https://dev.slugkit.dev/docs/guide-web-development): Strategic guide for integrating SlugKit into web applications. Focuses on security models, architecture patterns, and framework considerations rather than implementation details.
- [Pattern Advanced Features](https://dev.slugkit.dev/docs/pattern-advanced-features)
- [Pattern Cookbook](https://dev.slugkit.dev/docs/pattern-cookbook)
- [Pattern Dictionary Reference](https://dev.slugkit.dev/docs/pattern-dictionary-reference)
- [Pattern Performance Optimization](https://dev.slugkit.dev/docs/pattern-performance-optimization): Master capacity planning, pattern efficiency, and production deployment strategies. Learn mathematical optimization, performance characteristics, and scaling patterns from thousands to billions of unique identifiers.
- [Pattern Syntax Basics](https://dev.slugkit.dev/docs/pattern-syntax-basics)
- [Django Backend Integration Recipe](https://dev.slugkit.dev/docs/recipe-django-backend)
- [Next.js Application Integration Recipe](https://dev.slugkit.dev/docs/recipe-nextjs-app)
- [TypeScript SDK: Browser Usage](https://dev.slugkit.dev/docs/sdk-typescript-browser)
- [TypeScript SDK: Installation & Setup](https://dev.slugkit.dev/docs/sdk-typescript-installation)
- [TypeScript SDK: Node.js Usage](https://dev.slugkit.dev/docs/sdk-typescript-nodejs)
- [TypeScript SDK: React Integration](https://dev.slugkit.dev/docs/sdk-typescript-react)
- [API Debugging Guide](https://dev.slugkit.dev/docs/troubleshooting-api-debugging)
- [Common Errors and Solutions](https://dev.slugkit.dev/docs/troubleshooting-common-errors)
- [Performance Troubleshooting](https://dev.slugkit.dev/docs/troubleshooting-performance)
- [Troubleshooting and Support](https://dev.slugkit.dev/docs/troubleshooting-support)

## essential
- [API Reference](https://dev.slugkit.dev/docs/api-reference)

## docs
- [Series Management API](https://dev.slugkit.dev/docs/api-series-management)
- [Contacts](https://dev.slugkit.dev/docs/contacts)
- [SlugKit Developer Portal](https://dev.slugkit.dev/docs/developer-portal-home): Welcome to SlugKit's developer portal. Generate beautiful, unique IDs that humans actually want to read. Get started in 5 minutes with our quickstart guides.
- [Python SDK Advanced Usage](https://dev.slugkit.dev/docs/sdk-python-advanced): Advanced features of the SlugKit Python SDK including async/await, comprehensive error handling, streaming, custom HTTP clients, and production best practices.
- [Python SDK Installation & Setup](https://dev.slugkit.dev/docs/sdk-python-installation)
- [Python SDK Quickstart](https://dev.slugkit.dev/docs/sdk-python-quickstart)

## article
- [SlugKit Generator Benchmark - Aug 28 2025](https://dev.slugkit.dev/docs/axiomatic-tutor-mcx): New benchmark results after introducing dictionary indexes
- [🎉 TypeScript SDK is Live!](https://dev.slugkit.dev/docs/jocund-clay-mmx)
- [From 300µs to Sub-Microsecond: Building SlugKit While Falling Down the Performance Rabbit Hole](https://dev.slugkit.dev/docs/laughing-fetishism-cxx): The journey from finding spectacularly inefficient code to building a microsecond-latency ID generator—complete with Python, PostgreSQL, C++, Feistel networks, prime number optimization, and way too much fun with Roman numerals.
- [How It Works: The Slug Science of SlugKit](https://dev.slugkit.dev/docs/slug-science-fiction): There are UUIDs. There are incrementing integers. And then… there are slugs.
- [SlugKit Generator Benchmark - Aug 28 2025 / add dictionary cache](https://dev.slugkit.dev/docs/smitten-mileage-mdx): Benchmarks after adding a cache for filtered dictionaries
- [P####R0: `string_markup` - Move-Safe String Component References](https://dev.slugkit.dev/docs/trained-molle-cdi): We propose `std::string_markup`, a lightweight vocabulary type for referring to substrings within owned strings while maintaining value semantics and move safety. This solves a common antipattern where `std::string_view` members create dangling references after move operations.
- [SlugKit MCP Server](https://dev.slugkit.dev/docs/untangled-ecdysiast-lxi): SlugKit MCP Server announcement and description

## content
- [Core Value Proposition](https://dev.slugkit.dev/docs/core-value-proposition): Core SlugKit value proposition
- [Quick Start](https://dev.slugkit.dev/docs/developer-onboarding-journey)
- [Generate slugs with forge](https://dev.slugkit.dev/docs/integration-examples): Integration examples section for the landing page
- [On-Premises Products](https://dev.slugkit.dev/docs/on-prem-products)
- [Pattern Playground - Interactive Slug Generator](https://dev.slugkit.dev/docs/pattern-playground-seo): Interactive tool for experimenting with SlugKit's powerful pattern language. Test patterns in real-time, explore advanced features, and discover the perfect slug generation strategy for your application.
- [Pattern Playground Teaser](https://dev.slugkit.dev/docs/pattern-teaser)
- [SaaS products](https://dev.slugkit.dev/docs/saas-products)
- [Technical Highlights](https://dev.slugkit.dev/docs/technical-highlights): SlugKit technical highlights

## not-for-humans
- [SlugKit Dictionary & Tag Reference](https://dev.slugkit.dev/docs/dictionary-and-tag-reference-for-agents): SlugKit Dictionary & Tag Reference for AI Agents
- [SlugKit Pattern Syntax Reference](https://dev.slugkit.dev/docs/pattern-syntax-reference-for-agents): Pattern Syntax Reference for AI Agents

## docs-navigation
- [SlugKit Developer Portal Navigation Structure](https://dev.slugkit.dev/docs/doc-toc-developer-portal): Complete navigation structure and content organisation for the SlugKit developer documentation portal in proper YAML format

## benchmark
- [SlugKit Generator Benchmark - Aug 27 2025](https://dev.slugkit.dev/docs/governing-faculty-mli): SlugKit generator benchmarks report

## typescript
- [MCP Integration Guide](https://dev.slugkit.dev/docs/guide-mcp-integration)

## product-description
- [SlugKit On-Premise Core](https://dev.slugkit.dev/docs/on-premise-core): Production-ready containerised slug generation requiring external PostgreSQL v15+ database (v16+ recommended). Container handles migrations and dictionary loading. Deploy with license file and DATABASE_URL for multi-container scaling based on subscription plan.
- [SlugKit On-Premise Enterprise](https://dev.slugkit.dev/docs/on-premise-enterprise): Custom-tailored solutions for unique requirements beyond standard plans. Air-gapped deployment, unlimited features, bespoke development, and specialized containers. Submit a feature request to explore custom solutions.
- [SlugKit On-Premise Lite](https://dev.slugkit.dev/docs/on-premise-lite): Stateless containerised slug generation with embedded dictionaries. Deploy from ghcr.io/slugkit/slugkit-lite with only a license file mount required. Perfect for batch processing and CI/CD workflows. Just $3/month.
- [SlugKit Business Plan](https://dev.slugkit.dev/docs/saas-business): Enterprise-ready slug generation with 100k daily mint operations, 50k daily forge operations, 20 series, unlimited slice windows, and business-critical support for just $20/month.
- [SlugKit Developer Plan](https://dev.slugkit.dev/docs/saas-developer): Get all three generation modes (forge, mint, slice) with 10,000 daily operations each, 5 series, and professional support for just $5/month. Perfect for production applications and growing teams.
- [SlugKit SaaS Enterprise](https://dev.slugkit.dev/docs/saas-enterprise): Custom cloud solutions with dedicated infrastructure options, unlimited scale, and bespoke features. Perfect for unique requirements beyond standard SaaS plans. Submit a feature request for tailored cloud deployment.
- [SlugKit Friends & Family Plan](https://dev.slugkit.dev/docs/saas-fnf): # SlugKit Friends & Family Plan Our most generous plan, awarded to early adopters who help shape Sl
- [SlugKit Free Plan](https://dev.slugkit.dev/docs/saas-free): Start generating unique, human-readable slugs at no cost. Get 1,000 daily mint operations, 3 series, and full pattern language access. Perfect for learning, personal projects, and small applications.
- [SlugKit Beta Tester Plan](https://dev.slugkit.dev/docs/saas-promo): # SlugKit Beta Tester Plan Help us battle-test SlugKit in production and get 10x the capacity of ou
- [SlugKit Startup Plan](https://dev.slugkit.dev/docs/saas-startup): Perfect for scaling startups and growing teams. Get 20,000 daily operations for forge and mint, 10 series, 10k slice windows, and business-grade support for just $10/month.
- [What is Series in SlugKit?](https://dev.slugkit.dev/docs/what-is-series): A **series** in SlugKit is a stateful configuration that defines a unique sequence of slugs within an organisational scope. It combines pattern templates, deterministic seeding, and auto-managed counters to provide guaranteed uniqueness and high-performance slug generation.

## llm
- [SlugKit Pattern Examples by Use Case](https://dev.slugkit.dev/docs/patter-examples-for-agents): Pattern examples for AI agents

## products
- [Product Description](https://dev.slugkit.dev/docs/products)

## reference
- [Python SDK API Reference](https://dev.slugkit.dev/docs/sdk-python-api-reference)
- [SlugKit CLI Reference](https://dev.slugkit.dev/docs/slugkit-cli-reference): Complete command-line reference for the SlugKit CLI tool, including all commands, options, examples, and common workflows.

## mandatory
- [SlugKit Preview and Development Environments – Terms of Service](https://dev.slugkit.dev/docs/tos-dev-2025-07)

## Optional
- [Cookie Policy - 2025-08](https://dev.slugkit.dev/docs/cookie-policy-2025-08)
- [End-User License Agreement (EULA) - 2025-06](https://dev.slugkit.dev/docs/eula-2025-06)
- [Privacy Policy - 2025-06](https://dev.slugkit.dev/docs/privacy-policy-2025-06)
- [Refund Policy - 2025-08](https://dev.slugkit.dev/docs/refund-policy-2025-08): # Refund and Cancellation Policy **Effective Date:** August 15, 2025 **Version:** 2025-8 ## 1. Ref
- [Terms of Service (TOS) - 2025-08](https://dev.slugkit.dev/docs/tos-2025-08)