3gpp-mcp-server

# 3GPP MCP Server v2 - Charging & Billing Expert **Transform your AI assistant into a 3GPP charging and billing expert in 5 minutes!** [![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-brightgreen)](https://modelcontextprotocol.io/) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ## What This Does **Before**: Ask AI about 5G charging or billing - Get generic, unhelpful response **After**: Ask AI + 3GPP MCP Server - Get expert-level guidance with charging specifications, implementation roadmaps, and billing integration strategies ## Quick Start (2 Minutes) ### ⚡ One-Command Installation ```bash # Install and configure automatically (after NPM publishing) npx 3gpp-mcp-charging@latest init # For local development/testing (before publishing): npm run install:cli ``` That's it! The installer will: - ✅ Auto-detect your AI client (Claude Desktop, VS Code, Cursor) - ✅ Install and build the MCP server - ✅ Configure your AI client automatically - ✅ Test the connection ### 🎯 Client-Specific Installation **For Claude Desktop:** ```bash # After NPM publishing: npx 3gpp-mcp-charging@latest init --client claude # Local development: npm run install:claude ``` **For VS Code:** ```bash # After NPM publishing: npx 3gpp-mcp-charging@latest init --client vscode # Local development: npm run install:vscode ``` **For Cursor IDE:** ```bash # After NPM publishing: npx 3gpp-mcp-charging@latest init --client cursor # Local development: npm run install:cursor ``` ### 🧪 Test It Works Ask your AI assistant: *"Can you give me a strategic learning path for implementing 5G converged charging with CHF?"* You should get expert-level guidance with specific charging specifications, implementation phases, and billing integration details! ## What You Get ### **Expert Charging & Billing Research Methodology** - Structured learning paths for charging systems implementation - Specific 3GPP charging specification sections to read - Billing integration roadmaps with timelines ### **Practical Charging Implementation Guidance** - Component-level charging system requirements - Common billing integration pitfalls and how to avoid them - Testing strategies for charging systems validation ### **Educational Value for Telecom Billing** - Progressive learning from basic charging concepts to 5G converged charging - Connection between policy control, charging, and billing systems - Professional methodology for systematic charging system study ### **Performance Benefits** - <500ms response times - <100MB memory usage - Support for 1000+ concurrent users - 95% resource reduction vs. data hosting approach ## Available Tools | Tool | Purpose | Input | Output | |------|---------|-------|--------| | `guide_specification_search` | Find relevant charging specs | Charging query + expertise level | Charging spec suggestions + search strategy | | `explain_3gpp_structure` | Learn 3GPP charging organization | Charging focus area | Educational content + charging navigation | | `map_requirements_to_specs` | Map charging needs to specs | Charging requirements | Primary charging specs + reading order | | `generate_research_strategy` | Create charging research plan | Charging topic + complexity | Phased charging approach + timeline | ## Available Resources | Resource | Purpose | Content | |----------|---------|---------| | `3gpp://knowledge/series` | Specification series guide | Complete guide to 3GPP series 21-38 with charging focus | | `3gpp://knowledge/protocols` | Protocol relationships | Charging protocols: CHF, OCS, PCRF, PCF, Diameter mappings | | `3gpp://knowledge/research-patterns` | Research methodologies | Proven charging research patterns and billing approaches | ## Project Structure ``` 3gpp-mcp-server-v2/ ├── src/ # Source code │ ├── index.ts # MCP server entry point │ ├── types/guidance.ts # TypeScript interfaces │ └── utils/ # Core components │ ├── guidance-engine.ts # Query analysis and guidance generation │ ├── knowledge-base.ts # 3GPP domain knowledge │ └── template-generator.ts # Response formatting ├── docs/ # User documentation │ ├── basics/ # Getting started guides │ ├── how-to/ # Real-world workflows │ ├── comparisons/ # Before/after examples │ └── user-journeys/ # Role-specific guides ├── tests/ # Test suite ├── mcp-setup.sh/.bat # Automated setup scripts └── claude-desktop-config.json # Configuration templates ``` ## Documentation ### **Getting Started** - **[Quick Start](docs/basics/README.md)** - 30-second overview and setup options - **[What Is This?](docs/basics/what-is-3gpp-mcp-server.md)** - Non-technical explanation - **[Installation Guide](docs/basics/installation-guide.md)** - 5-minute setup with screenshots - **[MCP Explained Simply](docs/basics/mcp-explained-simply.md)** - Understanding the technology ### **See the Difference** - **[Side-by-Side Examples](docs/comparisons/side-by-side-examples.md)** - Same queries, dramatically different results - **[LLM vs MCP Comparison](docs/comparisons/)** - Detailed before/after analysis ### **Real-World Examples** - **[Research 5G Charging](docs/how-to/research-5g-charging/)** - Complete charging workflow example - **[Find Billing Implementation Guidance](docs/how-to/find-billing-implementation-guidance/)** - Charging requirements to specifications - **[Troubleshoot Charging Issues](docs/how-to/troubleshoot-charging-issues/)** - Systematic charging problem solving ### **User Journeys** - **[Telecom Charging Newcomer](docs/user-journeys/telecom-newcomer.md)** - 8-week charging & billing learning plan - **[Experienced Developer](docs/user-journeys/experienced-developer.md)** - Software engineer entering telecom charging - **[Billing System Architect](docs/user-journeys/billing-system-architect.md)** - Charging system design and integration ## Requirements - **Node.js 18+** - [Download from nodejs.org](https://nodejs.org/) - **MCP-compatible AI assistant** (Claude Desktop, VS Code, Cursor, or others) - **2 minutes** for setup (with NPM installation) ## Installation Options ### Option 1: NPM Installation (Recommended) ```bash # One-command installation with auto-configuration npx 3gpp-mcp-charging@latest init # Or install globally for repeated use npm install -g 3gpp-mcp-charging 3gpp-mcp-charging init ``` ### Option 2: Manual Setup from Source ```bash git clone https://github.com/edhijlu/3gpp-mcp-server.git cd 3gpp-mcp-server/3gpp-mcp-server-v2 npm install npm run build # Use the built-in CLI for configuration npm run install:cli ``` ### Option 3: Development Mode ```bash git clone https://github.com/edhijlu/3gpp-mcp-server.git cd 3gpp-mcp-server/3gpp-mcp-server-v2 npm install npm run dev # Development with watch mode ``` ### 🔍 Check System Status ```bash # After NPM publishing: npx 3gpp-mcp-charging@latest info # Shows detected AI clients # Local development: npm run info ``` ## Example Queries to Try Once connected, try these queries with your AI assistant: ### Beginner Charging Queries ``` "Give me a beginner's learning path for understanding 3GPP charging systems" "What specifications should I read to understand online vs offline charging?" "Explain the 3GPP charging architecture and how CDRs are generated" ``` ### Intermediate Charging Queries ``` "How does 5G converged charging work and which specs define CHF procedures?" "What's the difference between 4G PCRF and 5G PCF for charging control?" "I need to implement Diameter Ro interface - what components do I need to build?" ``` ### Advanced Charging Queries ``` "Compare the charging architectures of 4G and 5G systems" "What are the key implementation challenges for network slice charging?" "Generate a research strategy for migrating from legacy billing to 5G charging" ``` ## Scripts | Script | Purpose | |--------|---------| | `npm run build` | Compile TypeScript to JavaScript | | `npm run dev` | Watch mode for development | | `npm run mcp` | Start MCP server | | `npm run mcp:dev` | Development mode with live reload | | `npm run install:cli` | Interactive installation | | `npm run install:claude` | Install for Claude Desktop | | `npm run install:cursor` | Install for Cursor IDE | | `npm run install:vscode` | Install for VS Code | | `npm run info` | Show system and client info | | `npm test` | Run test suite | | `npm run lint` | Check code quality | ## Testing ```bash # Run all tests npm test # Run specific test categories npm test -- --testNamePattern="GuidanceEngine" npm test -- --testNamePattern="KnowledgeBase" npm test -- --testNamePattern="Integration" ``` ## Performance - **Response Time**: <500ms for guidance generation - **Memory Usage**: <100MB typical runtime - **Concurrent Users**: 1000+ supported - **Startup Time**: <5 seconds initialization ## The v2 Philosophy: "Guide, Don't Host" Unlike traditional approaches that try to host massive charging datasets: **v2 provides intelligent charging guidance that:** - Teaches charging research methodology - Points to authoritative 3GPP charging sources - Adapts to user charging expertise level - Provides billing implementation roadmaps - Stays current with latest charging standards **Benefits:** - 95% resource reduction (50MB vs 15GB+) - 10x faster responses (<500ms vs 3-5 seconds) - Educational value - teaches charging methodology - Always current - guides to live charging sources - Highly scalable (1000+ concurrent users) - Expert charging domain knowledge ## Contributing We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. ### Development Setup ```bash git clone https://github.com/edhijlu/3gpp-mcp-server.git cd 3gpp-mcp-server/3gpp-mcp-server-v2 npm install npm run dev # Start development server ``` ## License MIT License - see [LICENSE](LICENSE) file for details. ## Support - **Documentation**: Comprehensive guides in the `/docs` folder - **Issues**: [GitHub Issues](https://github.com/edhijlu/3gpp-mcp-server/issues) - **Discussions**: [GitHub Discussions](https://github.com/edhijlu/3gpp-mcp-server/discussions) ## Quick Links - **[Get Started in 5 Minutes](docs/basics/installation-guide.md)** - **[See Before/After Examples](docs/comparisons/side-by-side-examples.md)** - **[Try a Complete Charging Workflow](docs/how-to/research-5g-charging/)** - **[Find Your User Journey](docs/user-journeys/)** --- **Ready to transform your 3GPP charging and billing research?** Start with the [installation guide](docs/basics/installation-guide.md) and experience expert-level charging guidance in minutes!