diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..4998a9f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,70 @@ +name: Bug report +description: Report a problem with MCPProxy +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to file a bug report. Please search existing + issues first to avoid duplicates. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear and concise description of the bug. + placeholder: When I run `mcpproxy serve` ... + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: Minimal, ordered steps so a maintainer can reproduce. + value: | + 1. + 2. + 3. + validations: + required: true + - type: input + id: version + attributes: + label: MCPProxy version + description: Output of `mcpproxy version` + placeholder: "v0.31.1 (personal) darwin/arm64" + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating system + options: + - macOS + - Linux + - Windows + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant logs + description: | + Logs from `~/.mcpproxy/logs/main.log` or `mcpproxy upstream logs `. + Redact any secrets first. + render: shell + - type: checkboxes + id: checks + attributes: + label: Pre-submission checklist + options: + - label: I searched existing issues and did not find a duplicate + required: true + - label: I ran `mcpproxy doctor` and reviewed the output + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0dcf4355 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & ideas (GitHub Discussions) + url: https://github.com/smart-mcp-proxy/mcpproxy-go/discussions + about: Ask usage questions, propose RFCs, or share your setup here. + - name: Report a security vulnerability + url: https://github.com/smart-mcp-proxy/mcpproxy-go/security/advisories/new + about: Please report security issues privately via GitHub Security Advisories, not public issues. + - name: Documentation + url: https://docs.mcpproxy.app/ + about: Read the docs before filing; your answer may already be there. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..be575fb6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature request +description: Suggest an idea or enhancement for MCPProxy +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem / motivation + description: What problem does this solve? What are you trying to do? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed solution + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + - type: dropdown + id: edition + attributes: + label: Which edition? + options: + - Personal + - Server + - Both / not sure + validations: + required: true + - type: checkboxes + id: checks + attributes: + label: Pre-submission checklist + options: + - label: I searched existing issues and discussions for a similar request + required: true diff --git a/SECURITY.md b/.github/SECURITY.md similarity index 95% rename from SECURITY.md rename to .github/SECURITY.md index 85af5e7a..bcb90796 100644 --- a/SECURITY.md +++ b/.github/SECURITY.md @@ -74,7 +74,7 @@ Returns: { "servers": [ { - "name": "untrusted-server", + "name": "untrusted-server", "quarantined": true, "url": "http://example.com", "created": "2024-01-01T00:00:00Z" @@ -95,7 +95,7 @@ Returns detailed tool descriptions for security analysis with quoted description ```json { "server": "untrusted-server", - "quarantine_status": "ACTIVE", + "quarantine_status": "ACTIVE", "tools": [ { "name": "suspicious_tool", @@ -239,7 +239,7 @@ The system tray includes quarantine management: ### For Users 1. **Always review quarantined servers** before approving -2. **Be suspicious of complex tool descriptions** +2. **Be suspicious of complex tool descriptions** 3. **Check for hidden instructions** in tool descriptions 4. **Verify server sources** before adding to mcpproxy 5. **Use quarantine management tools** regularly @@ -299,7 +299,25 @@ The system tray includes quarantine management: ### Reporting -If you discover Tool Poisoning Attacks or other security vulnerabilities, please report them through the appropriate channels for your organization or the mcpproxy-go project. +We take security seriously. **Please do not report security vulnerabilities through +public GitHub issues, discussions, or pull requests.** + +Instead, report them privately using +**[GitHub Security Advisories](https://github.com/smart-mcp-proxy/mcpproxy-go/security/advisories/new)** +("Report a vulnerability" on the repository's Security tab). This creates a private, +coordinated disclosure channel visible only to maintainers. + +Please include, where possible: + +- A description of the vulnerability and its impact +- Steps to reproduce (proof-of-concept welcome) +- Affected version(s) (`mcpproxy version`) +- Any suggested remediation + +**Response targets:** initial acknowledgement within 48 hours, triage and severity +assessment within 5 business days. We follow coordinated disclosure and aim to ship a +fix or mitigation before public disclosure (typically within 90 days). We are happy to +credit reporters in the release notes unless you prefer to remain anonymous. ## References @@ -598,7 +616,7 @@ When reviewing quarantined tools, look for: - [ ] Social engineering language and urgency tactics - [ ] Credential theft attempts - [ ] Instructions to conceal actions from users -- [ ] Base64 encoding or other obfuscation methods +- [ ] Base64 encoding or other obfuscation methods ## LLM Security Analysis Guide @@ -614,7 +632,7 @@ upstream_servers list_quarantined This shows all servers currently in quarantine that need security review. #### Step 2: Inspect Each Server's Tools -```bash +```bash upstream_servers inspect_quarantined name="server-name" ``` @@ -676,4 +694,4 @@ Based on your analysis: **Analysis:** ❌ **MALICIOUS** - Contains hidden instruction in `` tag requesting SSH key access. This is a classic Tool Poisoning Attack attempting to exfiltrate sensitive credentials. -**Recommendation:** Keep server quarantined indefinitely. \ No newline at end of file +**Recommendation:** Keep server quarantined indefinitely. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..9d4f96f6 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,41 @@ +version: 2 +updates: + - package-ecosystem: gomod + directory: "/" + schedule: + interval: weekly + open-pull-requests-limit: 10 + commit-message: + prefix: "chore(deps)" + groups: + go-dependencies: + patterns: + - "*" + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: weekly + commit-message: + prefix: "chore(ci)" + - package-ecosystem: npm + directory: "/frontend" + schedule: + interval: weekly + open-pull-requests-limit: 10 + commit-message: + prefix: "chore(deps)" + groups: + frontend-dependencies: + patterns: + - "*" + - package-ecosystem: npm + directory: "/website" + schedule: + interval: weekly + open-pull-requests-limit: 10 + commit-message: + prefix: "chore(deps)" + groups: + website-dependencies: + patterns: + - "*" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..579500fd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,87 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the project maintainers privately by opening a confidential report +via the repository's **Security → Report a vulnerability** form +(GitHub private vulnerability reporting). All complaints will be reviewed and +investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations