Quarkus MCP Server Instructions (#96)
* Create quarkus-mcp-server-sse.instructions.md * Fixed readme and metadata for instruction
This commit is contained in:
Bruno Borges
GitHub
parent
5d42f2021a
commit
4746131148
@ -55,6 +55,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Power Platform Connectors Schema Development Instructions](instructions/power-platform-connector.instructions.md) | Comprehensive development guidelines for Power Platform Custom Connectors using JSON Schema definitions. Covers API definitions (Swagger 2.0), API properties, and settings configuration with Microsoft extensions. | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-connector.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-connector.instructions.md) |
|
||||
| [PowerShell Cmdlet Development Guidelines](instructions/powershell.instructions.md) | PowerShell cmdlet and scripting best practices based on Microsoft guidelines | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell.instructions.md) |
|
||||
| [Python Coding Conventions](instructions/python.instructions.md) | Python coding conventions and guidelines | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpython.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpython.instructions.md) |
|
||||
| [Quarkus MCP Server](instructions/quarkus-mcp-server-sse.instructions.md) | Quarkus and MCP Server with HTTP SSE transport development standards and instructions | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fquarkus-mcp-server-sse.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fquarkus-mcp-server-sse.instructions.md) |
|
||||
| [Quarkus](instructions/quarkus.instructions.md) | Quarkus development standards and instructions | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fquarkus.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fquarkus.instructions.md) |
|
||||
| [ReactJS Development Instructions](instructions/reactjs.instructions.md) | ReactJS development standards and best practices | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Freactjs.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Freactjs.instructions.md) |
|
||||
| [Ruby on Rails](instructions/ruby-on-rails.instructions.md) | Ruby on Rails coding conventions and guidelines | [](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fruby-on-rails.instructions.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fruby-on-rails.instructions.md) |
|
||||
|
||||
49
instructions/quarkus-mcp-server-sse.instructions.md
Normal file
49
instructions/quarkus-mcp-server-sse.instructions.md
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
applyTo: '*'
|
||||
description: 'Quarkus and MCP Server with HTTP SSE transport development standards and instructions'
|
||||
---
|
||||
# Quarkus MCP Server
|
||||
|
||||
Build MCP servers with Java 21, Quarkus, and HTTP SSE transport.
|
||||
|
||||
## Stack
|
||||
|
||||
- Java 21 with Quarkus Framework
|
||||
- MCP Server Extension: `mcp-server-sse`
|
||||
- CDI for dependency injection
|
||||
- MCP Endpoint: `http://localhost:8080/mcp/sse`
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
quarkus create app --no-code -x rest-client-jackson,qute,mcp-server-sse your-domain-mcp-server
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
- Use standard Java naming conventions (PascalCase classes, camelCase methods)
|
||||
- Organize in packages: `model`, `repository`, `service`, `mcp`
|
||||
- Use Record types for immutable data models
|
||||
- State management for immutable data must be managed by repository layer
|
||||
- Add Javadoc for public methods
|
||||
|
||||
## MCP Tools
|
||||
|
||||
- Must be public methods in `@ApplicationScoped` CDI beans
|
||||
- Use `@Tool(name="tool_name", description="clear description")`
|
||||
- Never return `null` - return error messages instead
|
||||
- Always validate parameters and handle errors gracefully
|
||||
|
||||
## Architecture
|
||||
|
||||
- Separate concerns: MCP tools → Service layer → Repository
|
||||
- Use `@Inject` for dependency injection
|
||||
- Make data operations thread-safe
|
||||
- Use `Optional<T>` to avoid null pointer exceptions
|
||||
|
||||
## Common Issues
|
||||
|
||||
- Don't put business logic in MCP tools (use service layer)
|
||||
- Don't throw exceptions from tools (return error strings)
|
||||
- Don't forget to validate input parameters
|
||||
- Test with edge cases (null, empty inputs)
|
||||
Loading…
x
Reference in New Issue
Block a user