shoring up the repo for release

Author: scottHAT

.gitignore

@@ -7,6 +7,7 @@ plan.md
 plan_pip.md
 SERVER_COMPATIBILITY.md
 mcp_testing/server_configs/*
+opensource_plan.md
 
 # Virtual environment
 .venv/

CONTRIBUTING.md

@@ -12,7 +12,7 @@ Please be respectful and considerate of others when contributing to this project
 
 If you find a bug or have a suggestion for improvement:
 
-1. Check if the issue already exists in the [GitHub Issues](https://github.com/your-username/mcp-protocol-validator/issues)
+1. Check if the issue already exists in the [GitHub Issues](https://github.com/Janix-ai/mcp-protocol-validator/issues)
 2. If not, create a new issue using the appropriate template
 3. Provide as much detail as possible, including steps to reproduce, expected behavior, and your environment
 

README.md

@@ -303,6 +303,87 @@ pytest
 pytest mcp_testing/tests/base_protocol/
 ```
 
+## Quick Start
+
+### Quickest Way to Test a Server
+
+For quick validation of MCP server implementations, you can use these minimal testing commands:
+
+#### For STDIO Servers:
+
+```bash
+# Basic interaction - simplest test to verify server works
+python -m mcp_testing.scripts.basic_interaction --server-command "./minimal_mcp_server/minimal_mcp_server.py"
+
+# Run a full compliance test
+python -m mcp_testing.scripts.compliance_report --server-command "./minimal_mcp_server/minimal_mcp_server.py" --protocol-version 2025-03-26
+```
+
+#### For HTTP Servers:
+
+```bash
+# Quick HTTP test
+python -m mcp_testing.scripts.http_test --server-url http://localhost:8000/mcp --protocol-version 2025-03-26
+
+# Simple connectivity check
+python minimal_http_server/check_server.py http://localhost:8000/mcp
+```
+
+### Advanced Testing Options
+
+For more comprehensive testing with detailed options:
+
+#### STDIO Testing:
+
+```bash
+# Generate a detailed compliance report
+python -m mcp_testing.scripts.compliance_report \
+  --server-command "./minimal_mcp_server/minimal_mcp_server.py" \
+  --protocol-version 2025-03-26 \
+  --output-dir "./reports"
+
+# Test with timeout settings for better stability
+python -m mcp_testing.scripts.compliance_report \
+  --server-command "./minimal_mcp_server/minimal_mcp_server.py" \
+  --test-timeout 30 \
+  --tools-timeout 15
+
+# Test only tool functionality
+python -m mcp_testing.scripts.compliance_report \
+  --server-command "./minimal_mcp_server/minimal_mcp_server.py" \
+  --test-mode tools
+```
+
+#### HTTP Testing:
+
+```bash
+# Comprehensive HTTP test with debug output
+python -m mcp_testing.scripts.http_test \
+  --server-url http://localhost:8000/mcp \
+  --protocol-version 2025-03-26 \
+  --debug
+
+# Generate an HTTP test report
+python -m mcp_testing.scripts.http_test \
+  --server-url http://localhost:8000/mcp \
+  --protocol-version 2025-03-26 \
+  --output-dir "./reports"
+```
+
+For testing pip-installed servers, ensure you're in the same virtual environment:
+
+```bash
+# Install server and testing framework in the same environment
+pip install mcp-server-fetch sseclient-py==1.7.2
+
+# Test a pip-installed server
+python -m mcp_testing.scripts.basic_interaction \
+  --server-command "python -m mcp_server_fetch" \
+  --protocol-version 2024-11-05
+```
+
+See the [Testing Pip-Installed MCP Servers](#testing-pip-installed-mcp-servers) section for more details.
+
 ## License
 
 SPDX-License-Identifier: AGPL-3.0-or-later

SECURITY.md

@@ -0,0 +1,48 @@
+# Security Policy
+
+## Supported Versions
+
+We currently provide security updates for the following versions of the MCP Protocol Validator:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+The MCP Protocol Validator team takes security seriously. If you believe you've found a security vulnerability, please follow these steps:
+
+1. **Do not disclose the vulnerability publicly**
+2. **Email us directly** at [[email protected]](mailto:[email protected]) with details about the vulnerability
+3. Include the following information in your report:
+   - Type of issue
+   - Full paths of source file(s) related to the issue
+   - Location of the affected source code
+   - Any special configuration required to reproduce the issue
+   - Step-by-step instructions to reproduce the issue
+   - Proof-of-concept or exploit code (if possible)
+   - Impact of the issue, including how an attacker might exploit it
+
+## Response Process
+
+We are committed to the following response process:
+
+- We will acknowledge receipt of your vulnerability report within 3 business days
+- We will provide an initial assessment of the report within 10 business days
+- We will keep you informed of our progress throughout the process
+- We will notify you when the vulnerability has been fixed
+
+## Security Best Practices
+
+When using the MCP Protocol Validator in your own projects, we recommend the following security best practices:
+
+1. **Keep your dependencies updated**: Regularly update the MCP Protocol Validator and its dependencies to benefit from security patches
+2. **Use caution with file operations**: When using the file operation tools in the MCP servers, be aware of potential security implications in your specific environment
+3. **Control network access**: When using the HTTP MCP server, ensure it's only accessible to trusted clients or over secure networks
+
+## Responsible Disclosure
+
+We follow responsible disclosure principles. After a fix has been developed and released, we encourage security researchers to disclose the vulnerability in a responsible manner, giving users time to update their installations. We will credit security researchers who report valid vulnerabilities and work with us through the entire process.
+
+
+Thank you for helping to keep the MCP Protocol Validator and its users secure! 

setup.py

@@ -7,13 +7,13 @@
     name="mcp-protocol-validator",
     version="1.0.0",
     author="Scott Wilcox",
-    author_email="[email protected]",  # Replace with actual email
+    author_email="[email protected]",  # Updated email
     description="Testing framework and reference implementations for the Model Conversation Protocol (MCP)",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/scottwilcox/mcp-protocol-validator",
+    url="https://github.com/Janix-ai/mcp-protocol-validator",
     project_urls={
-        "Bug Tracker": "https://github.com/scottwilcox/mcp-protocol-validator/issues",
+        "Bug Tracker": "https://github.com/Janix-ai/mcp-protocol-validator/issues",
     },
     classifiers=[
         "Programming Language :: Python :: 3",