claude-central-gateway/docs/index.md

Documentation Index

Welcome to Claude Central Gateway documentation. Start here to find what you need.

Getting Started

New to the project? Start with these:

1. Quick Start (5 min read)

   • Deploy the gateway in 1 minute
   • Configure Claude Code
   • Verify it works
   • Troubleshooting tips

2. Project Overview & PDR (10 min read)

   • What this project does and why
   • Feature requirements and roadmap
   • When to use it (and when not to)

API & Integration

Building with the gateway? Use these:

3. API Reference (20 min read)
   • Complete endpoint documentation
   • Request/response formats
   • Authentication details
   • Code examples (curl, JavaScript)
   • Error handling

Technical Deep Dives

Understanding the architecture? Read these:

4. System Architecture (15 min read)

   • Request/response flow with diagrams
   • Tool use round-trip workflow
   • Data structures and schemas
   • Deployment topology
   • Stop reason mapping
   • Scalability characteristics

5. Code Standards (15 min read)

   • Codebase structure and module responsibilities
   • Naming conventions
   • Authentication implementation
   • Error handling patterns
   • Security practices
   • Performance considerations

Common Tasks

Deploy the Gateway

→ Quick Start

Configure Claude Code

→ Quick Start

Make API Requests

→ API Reference

Understand Tool Use

→ System Architecture

Map Models to Cheaper Providers

→ API Reference or Quick Start

Debug Issues

→ Quick Start

Understand Data Flow

→ System Architecture

Review Implementation Details

→ Code Standards

Documentation Map

docs/
├── index.md                      ← You are here
├── quick-start.md                ← Start here (5 min)
├── project-overview-pdr.md       ← What & why (10 min)
├── api-reference.md              ← API details (20 min)
├── system-architecture.md        ← How it works (15 min)
└── code-standards.md             ← Code details (15 min)

Search by Topic

Authentication & Security

• See Code Standards: Security Practices
• See API Reference: Authentication

Streaming Responses

• See System Architecture: Response Transformation
• See API Reference: Response (Streaming)

Tool Use / Function Calling

• See System Architecture: Tool Use Round-Trip
• See API Reference: Tool Definition
• See Code Standards: transform-response.js

Image Support

• See API Reference: Image Content Type
• See System Architecture: Content Block Handling

Error Handling

• See API Reference: Error Responses
• See Code Standards: Error Handling
• See Quick Start: Troubleshooting

Model Mapping & Configuration

• See API Reference: Configuration
• See Quick Start: Model Mapping Examples

Deployment Options

• See Quick Start: Deploy to Vercel
• See Quick Start: Cloudflare Workers
• See System Architecture: Deployment Topology

Stop Reasons & Generation Control

• See API Reference: Stop Reasons
• See System Architecture: Stop Reason Mapping
• See Code Standards: transform-response.js

Performance & Scalability

• See System Architecture: Scalability Characteristics
• See Code Standards: Performance Considerations

Future Roadmap & Limitations

• See Project Overview: Feature Roadmap
• See Project Overview: Known Limitations
• See API Reference: Limitations & Compatibility

Document Statistics

Document	Length	Focus	Audience
Quick Start	5 min	Getting started	Everyone
Project Overview	10 min	Vision & requirements	Product, decision makers
API Reference	20 min	Endpoints & examples	Developers integrating
System Architecture	15 min	Design & flow	Developers, maintainers
Code Standards	15 min	Implementation details	Developers, contributors

Learning Paths

"I Just Want to Use It"

1. Quick Start - Deploy and configure
2. API Reference - Code examples
3. Quick Start Troubleshooting - If issues arise

"I Want to Understand How It Works"

1. Project Overview - Context
2. System Architecture - Design
3. Code Standards - Implementation

"I'm Contributing to the Project"

1. Project Overview - Requirements
2. Code Standards - Structure & conventions
3. System Architecture - Data flow
4. Read the actual code in src/

"I'm Debugging an Issue"

1. Quick Start Troubleshooting - Common fixes
2. API Reference - Error codes
3. System Architecture - Error flow
4. Code Standards - Error patterns

Quick Links

• GitHub Repository: https://github.com/tiennm99/claude-central-gateway
• Deploy to Vercel: https://vercel.com/new/clone?repository-url=https://github.com/tiennm99/claude-central-gateway
• OpenAI API Documentation: https://platform.openai.com/docs/api-reference
• Anthropic API Documentation: https://docs.anthropic.com/en/docs/about/api-overview
• Claude Code Router (local alternative): https://github.com/musistudio/claude-code-router
• LiteLLM (enterprise alternative): https://github.com/BerriAI/litellm

FAQ

Q: Where do I start? A: Quick Start if you want to deploy immediately, or Project Overview if you want context first.

Q: How do I make API calls? A: API Reference

Q: Why did my request fail? A: Quick Start Troubleshooting or API Reference: Error Responses

Q: How does tool use work? A: System Architecture: Tool Use Round-Trip

Q: What's supported? A: README Features Section or API Reference

Q: How do I optimize costs? A: Quick Start Cost Optimization Tips

Q: Can I self-host? A: Yes, see Quick Start Alternative Deployments

Contributing

Want to contribute? Start with Code Standards to understand the architecture, then read the source code in src/.

Version History

• v1.0 (2025-04-05): Hono refactor with full tool use support, streaming, authentication
• v0.x: Initial OpenAI proxy implementation

Last Updated

April 5, 2025

---

Ready to get started? → Quick Start Guide