mvp24hours-dotnet-mcp 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,217 @@
+# Contributing to Mvp24Hours .NET MCP Server
+
+First off, thank you for considering contributing to Mvp24Hours .NET MCP Server! 🎉
+
+It's people like you that make this project such a great tool for the .NET community.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How Can I Contribute?](#how-can-i-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Your First Code Contribution](#your-first-code-contribution)
+  - [Pull Requests](#pull-requests)
+- [Development Setup](#development-setup)
+- [Style Guidelines](#style-guidelines)
+- [Community](#community)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [kallebelins@gmail.com](mailto:kallebelins@gmail.com).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
+
+- **Use a clear and descriptive title**
+- **Describe the exact steps to reproduce the problem**
+- **Provide specific examples** (code snippets, configuration files)
+- **Describe the behavior you observed and what you expected**
+- **Include your environment details** (Node.js version, OS, etc.)
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:
+
+- **Use a clear and descriptive title**
+- **Provide a detailed description of the proposed enhancement**
+- **Explain why this enhancement would be useful**
+- **Include examples of how the feature would be used**
+
+### Your First Code Contribution
+
+Unsure where to begin? Look for issues labeled:
+
+- `good first issue` - Simple issues perfect for newcomers
+- `help wanted` - Issues that need community help
+- `documentation` - Documentation improvements
+
+### Pull Requests
+
+1. **Fork the repository** and create your branch from `main`
+2. **Follow the setup instructions** below
+3. **Make your changes** following our style guidelines
+4. **Add tests** if applicable
+5. **Update documentation** if needed
+6. **Submit your pull request**
+
+#### Pull Request Checklist
+
+- [ ] Code follows the project's style guidelines
+- [ ] Self-review completed
+- [ ] Documentation updated (if applicable)
+- [ ] Tests added/updated (if applicable)
+- [ ] All tests pass
+- [ ] No new warnings
+
+## Development Setup
+
+### Prerequisites
+
+- Node.js 18.0.0 or higher
+- npm or yarn
+
+### Installation
+
+```bash
+# Clone your fork
+git clone https://github.com/YOUR-USERNAME/mvp24hours-dotnet-mcp.git
+cd mvp24hours-dotnet-mcp
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Start development mode (watch for changes)
+npm run dev
+```
+
+### Testing Your Changes
+
+```bash
+# Build and test locally
+npm run build
+node dist/index.js
+```
+
+### Project Structure
+
+```
+src/
+├── index.ts                    # MCP Server entry point
+├── tools/                      # MCP tools implementation
+│   ├── get-started.ts          # Framework overview
+│   ├── architecture-advisor.ts # Architecture selection
+│   ├── database-advisor.ts     # Database configuration
+│   └── ...                     # Other tools
+└── utils/
+    └── doc-loader.ts           # Documentation loader
+
+docs/                           # Documentation files
+├── ai-context/                 # AI context documentation
+├── modernization/              # Modernization guides
+└── ...                         # Other docs
+```
+
+## Style Guidelines
+
+### TypeScript
+
+- Use TypeScript strict mode
+- Prefer `const` over `let`
+- Use meaningful variable and function names
+- Add JSDoc comments for public functions
+- Keep functions small and focused
+
+### Commits
+
+We follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types:
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code refactoring
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+
+Examples:
+```
+feat(tools): add security-patterns tool
+fix(database-advisor): correct PostgreSQL configuration
+docs: update README with new tools
+```
+
+### Documentation
+
+- Use clear, concise language
+- Include code examples where helpful
+- Keep documentation up-to-date with code changes
+- Use Markdown formatting consistently
+
+## Adding New Tools
+
+When adding a new MCP tool:
+
+1. Create a new file in `src/tools/`
+2. Follow the existing tool pattern
+3. Register the tool in `src/index.ts`
+4. Add corresponding documentation in `docs/`
+5. Update the README.md with the new tool
+
+Example tool structure:
+
+```typescript
+import { z } from 'zod';
+
+export const myNewToolSchema = z.object({
+  parameter: z.string().describe('Parameter description'),
+});
+
+export async function myNewTool(args: z.infer<typeof myNewToolSchema>) {
+  // Implementation
+  return {
+    content: [
+      {
+        type: 'text',
+        text: '...',
+      },
+    ],
+  };
+}
+```
+
+## Community
+
+- **GitHub Discussions**: Ask questions, share ideas
+- **Issues**: Report bugs, request features
+- **Pull Requests**: Contribute code
+
+### Related Projects
+
+- [Mvp24Hours .NET Framework](https://github.com/kallebelins/mvp24hours-dotnet)
+- [Mvp24Hours .NET Samples](https://github.com/kallebelins/mvp24hours-dotnet-samples)
+- [Semantic Kernel Graph](https://github.com/kallebelins/semantic-kernel-graph)
+
+## Recognition
+
+Contributors will be recognized in:
+- The project's README
+- Release notes
+- Our community page
+
+Thank you for contributing! 🙏

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kallebe Lins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,221 @@
+# Mvp24Hours .NET MCP Server
+
+> Intelligent documentation routing for AI agents working with the Mvp24Hours .NET framework.
+
+## Problem Solved
+
+The Mvp24Hours framework has extensive documentation covering:
+- Multiple architecture templates (Minimal API, N-Layers, CQRS, DDD, Microservices, etc.)
+- Multiple database options (SQL Server, PostgreSQL, MongoDB, Redis)
+- AI implementation approaches (Semantic Kernel, SK Graph, Agent Framework)
+- .NET 9 modernization patterns
+- CQRS/Mediator patterns
+- Observability and messaging
+
+**The problem**: Loading all documentation at once overwhelms AI agents, causing them to lose context or provide incomplete answers.
+
+**The solution**: This MCP server provides specialized tools that act as "intelligent routers", returning only the relevant documentation based on specific queries.
+
+## Installation
+
+### From NPM (Recommended)
+
+```bash
+npm install -g @mvp24hours/dotnet-mcp
+```
+
+### From Source
+
+```bash
+git clone https://github.com/kallebelins/mvp24hours-dotnet-mcp
+cd mvp24hours-dotnet-mcp
+npm install
+npm run build
+```
+
+## Configuration
+
+### Cursor IDE
+
+Add to your `~/.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "mvp24hours-dotnet": {
+      "command": "npx",
+      "args": ["@mvp24hours/dotnet-mcp"]
+    }
+  }
+}
+```
+
+Or if installed from source:
+
+```json
+{
+  "mcpServers": {
+    "mvp24hours-dotnet": {
+      "command": "node",
+      "args": ["path/to/mvp24hours-dotnet-mcp/dist/index.js"]
+    }
+  }
+}
+```
+
+### Claude Desktop
+
+Add to your Claude Desktop config:
+
+```json
+{
+  "mcpServers": {
+    "mvp24hours-dotnet": {
+      "command": "npx",
+      "args": ["@mvp24hours/dotnet-mcp"]
+    }
+  }
+}
+```
+
+## Available Tools
+
+| Tool | Purpose |
+|------|---------|
+| `mvp24h_get_started` | Framework overview and quick start |
+| `mvp24h_architecture_advisor` | Recommends architecture based on requirements |
+| `mvp24h_database_advisor` | Recommends database and patterns |
+| `mvp24h_cqrs_guide` | CQRS/Mediator documentation |
+| `mvp24h_ai_implementation` | AI approach selection (SK, SKG, Agent Framework) |
+| `mvp24h_modernization_guide` | .NET 9 features and patterns |
+| `mvp24h_observability_setup` | OpenTelemetry configuration |
+| `mvp24h_messaging_patterns` | Async messaging (RabbitMQ, Channels) |
+| `mvp24h_core_patterns` | Core module (Guard Clauses, Value Objects, etc.) |
+| `mvp24h_infrastructure_guide` | Pipeline, Caching, WebAPI, CronJob |
+| `mvp24h_reference_guide` | Mapping, Validation, Specification, Migration |
+| `mvp24h_get_template` | Retrieves specific template code |
+
+## Usage Examples
+
+### Getting Started
+
+```
+User: I want to create a .NET project with Mvp24Hours
+
+AI calls: mvp24h_get_started({ focus: "overview" })
+→ Returns: Framework overview, quick reference, and next steps
+```
+
+### Choosing Architecture
+
+```
+User: I need to create an enterprise app with complex business rules
+
+AI calls: mvp24h_architecture_advisor({
+  complexity: "high",
+  business_rules: "complex",
+  team_size: "large"
+})
+→ Returns: Clean Architecture recommendation with project structure
+```
+
+### Database Configuration
+
+```
+User: I need to use PostgreSQL with transactions
+
+AI calls: mvp24h_database_advisor({
+  provider: "postgresql",
+  requirements: ["transactions", "complex-queries"]
+})
+→ Returns: PostgreSQL setup, EF Core config, Unit of Work pattern
+```
+
+### AI Implementation
+
+```
+User: I want to add a chatbot to my app
+
+AI calls: mvp24h_ai_implementation({ use_case: "chatbot" })
+→ Returns: Semantic Kernel Chat Completion template
+```
+
+### Getting Specific Template
+
+```
+User: Show me the CQRS template
+
+AI calls: mvp24h_get_template({ template_name: "cqrs" })
+→ Returns: Complete CQRS project structure and code
+```
+
+## Tool Flow
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                        User Request                             │
+└─────────────────────────────┬───────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────────┐
+│                    mvp24h_get_started                           │
+│                 (Overview & Direction)                          │
+└─────────────────────────────┬───────────────────────────────────┘
+                              │
+         ┌────────────────────┼────────────────────┐
+         │                    │                    │
+         ▼                    ▼                    ▼
+┌─────────────────┐  ┌─────────────────┐  ┌─────────────────┐
+│  architecture   │  │    database     │  │      ai         │
+│    advisor      │  │    advisor      │  │ implementation  │
+└────────┬────────┘  └────────┬────────┘  └────────┬────────┘
+         │                    │                    │
+         └────────────────────┼────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────────┐
+│                    mvp24h_get_template                          │
+│                   (Specific Code)                               │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+## Architecture
+
+```
+src/
+├── index.ts                    # MCP Server entry point
+├── tools/
+│   ├── get-started.ts          # Framework overview
+│   ├── architecture-advisor.ts # Architecture selection
+│   ├── database-advisor.ts     # Database configuration
+│   ├── cqrs-guide.ts           # CQRS/Mediator patterns
+│   ├── ai-implementation.ts    # AI approach selection
+│   ├── modernization-guide.ts  # .NET 9 features
+│   ├── observability-setup.ts  # Telemetry configuration
+│   ├── messaging-patterns.ts   # Async messaging
+│   ├── core-patterns.ts        # Core module patterns
+│   ├── infrastructure-guide.ts # Pipeline, WebAPI, CronJob
+│   ├── reference-guide.ts      # Mapping, Validation, Specification
+│   └── get-template.ts         # Template retrieval
+└── utils/
+    └── doc-loader.ts           # Documentation loader
+```
+
+## Why Multiple Tools?
+
+Instead of one large tool that dumps all documentation, specialized tools:
+
+1. **Reduce context size**: Each tool returns only relevant content
+2. **Improve accuracy**: Focused responses are more precise
+3. **Enable decision trees**: Tools can recommend other tools
+4. **Support iteration**: Users can drill down progressively
+
+## Related Projects
+
+- [Mvp24Hours .NET Framework](https://github.com/kallebelins/mvp24hours-dotnet)
+- [Mvp24Hours .NET Samples](https://github.com/kallebelins/mvp24hours-dotnet-samples)
+- [Semantic Kernel Graph](https://github.com/kallebelins/semantic-kernel-graph)
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * Mvp24Hours .NET MCP Server
+ *
+ * This MCP server provides intelligent documentation routing for AI agents
+ * working with the Mvp24Hours .NET framework. Instead of loading all documentation
+ * at once, it provides specialized tools that return only relevant content.
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG"}