preflight-tools 0.1.0__tar.gz

preflight_tools-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

preflight_tools-0.1.0/PKG-INFO

@@ -0,0 +1,336 @@
+Metadata-Version: 2.4
+Name: preflight-tools
+Version: 0.1.0
+Summary: Reference validators for autonomous systems protocols: MCP, A2A, ACE, OCC/OCS/OCP
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: mcp,a2a,ace,protocol-validation,autonomous-agents,compliance-testing
+Author: Kevin Broderick
+Author-email: kevin@syzygysys.com
+Requires-Python: >=3.10
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: jsonschema (>=4.26.0,<5.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: rich (>=13.0,<14.0)
+Requires-Dist: typer (>=0.15.0)
+Project-URL: Documentation, https://github.com/syzygysys/preflight-tools/blob/main/README.md
+Project-URL: Homepage, https://github.com/syzygysys/preflight-tools
+Project-URL: Repository, https://github.com/syzygysys/preflight-tools
+Description-Content-Type: text/markdown
+
+# Preflight Tools
+
+Reference validators for autonomous systems protocols: MCP, A2A, ACE, OCC/OCS/OCP
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+## Overview
+
+Preflight Tools provides reference implementations for protocol compliance validation across autonomous agent ecosystems. These validators catch common integration issues before deployment, saving hours of debugging.
+
+### Supported Protocols
+
+- **MCP** (Model Context Protocol) - Anthropic's protocol for LLM tool integration
+- **A2A** (Agent-to-Agent) - Peer communication protocol for autonomous agents
+- **ACE** (Autonomic Compliance Ecosystem) - Platform orchestration standards
+- **OCC/OCS/OCP** - *(Coming soon)* Observability, compliance, and policy protocols
+
+## Installation
+```bash
+# Via pip
+pip install preflight-tools
+
+# Via Poetry
+poetry add preflight-tools
+
+# From source
+git clone https://github.com/syzygysys/preflight-tools.git
+cd preflight-tools
+poetry install
+```
+
+## Quick Start
+
+### MCP Validation
+
+Validate your MCP server implementation against the specification:
+```bash
+# Validate a tools definition file
+mcp-preflight-check validate path/to/tools.py
+
+# Test a running server
+mcp-preflight-check test http://localhost:8000
+
+# Full report with verbose output
+mcp-preflight-check validate --verbose path/to/tools.py
+```
+
+**Example output:**
+```
+✅ Tool names: All valid [a-zA-Z0-9_-]
+✅ Properties schemas: All using objects {}
+✅ Content wrappers: All responses properly wrapped
+✅ Notification handling: Correctly implemented
+✅ JSON-RPC structure: All responses include required fields
+❌ Stdout pollution: Found 3 print statements that will break stdio transport
+
+Fix suggestions:
+  Line 42: Remove print() statement
+  Line 89: Use logging instead of print()
+  Line 134: Redirect to stderr
+```
+
+### A2A Validation
+
+*(Coming soon)* Validate Agent-to-Agent protocol implementations:
+```bash
+a2a-preflight-check validate path/to/agent_config.yml
+```
+
+## The Six Critical MCP Fixes
+
+This validator is built from real-world debugging of LAP::CORE's MCP integration. See the full story: [Debugging the Bridge](https://syzygysys.github.io/docs/architects_notebook/log_14.html)
+
+### 1. Tool Name Pattern
+
+**Problem:** Tool names with dots fail Zod validation  
+**Rule:** Must match `^[a-zA-Z0-9_-]{1,64}$`
+```python
+# ❌ FAILS
+{"name": "lap.health.ping"}
+
+# ✅ PASSES
+{"name": "lap_health_ping"}
+```
+
+### 2. Properties Schema Type
+
+**Problem:** Empty properties as `[]` instead of `{}`  
+**Rule:** JSON Schema requires properties to be an object
+```python
+# ❌ FAILS
+{
+    "inputSchema": {
+        "type": "object",
+        "properties": []  # Wrong type
+    }
+}
+
+# ✅ PASSES
+{
+    "inputSchema": {
+        "type": "object",
+        "properties": {}  # Correct type
+    }
+}
+```
+
+### 3. Content Wrapper Structure
+
+**Problem:** Returning raw data instead of MCP content structure  
+**Rule:** All responses must be wrapped
+```python
+# ❌ FAILS
+return {"status": "ok", "value": 42}
+
+# ✅ PASSES
+return {
+    "content": [{
+        "type": "text",
+        "text": json.dumps({"status": "ok", "value": 42})
+    }]
+}
+```
+
+### 4. Notification Handling
+
+**Problem:** Returning errors for notification requests (no `id` field)  
+**Rule:** Notifications don't expect responses
+```python
+# ❌ FAILS
+async def dispatch(self, request: dict) -> str:
+    method = request.get("method")
+    if method not in self.handlers:
+        return json.dumps({"error": "unknown method"})
+
+# ✅ PASSES
+async def dispatch(self, request: dict) -> str:
+    # Check if this is a notification (no "id" field)
+    if "id" not in request:
+        return ""  # Silent success
+    
+    method = request.get("method")
+    # ... handle request-response
+```
+
+### 5. Stdout Pollution
+
+**Problem:** Any output to stdout breaks JSON-RPC stdio transport  
+**Rule:** Redirect stderr early, never use print()
+```bash
+# ❌ FAILS - stderr goes to stdout
+poetry run mcp-server 2>> /tmp/debug.log
+
+# ✅ PASSES - redirect before Python starts
+exec 2>/tmp/debug.log; poetry run mcp-server
+```
+
+**In code:**
+```python
+# ❌ NEVER
+print("Debug message")
+
+# ✅ ALWAYS
+import logging
+logging.error("Debug message")  # Goes to stderr
+```
+
+### 6. JSON-RPC Response Structure
+
+**Problem:** Using `exclude_none=True` removes required fields when they're `None`  
+**Rule:** JSON-RPC 2.0 requires `id` and `jsonrpc` in every response
+```python
+# ❌ FAILS - removes 'id' when it's None
+class JsonRpcResponse(BaseModel):
+    jsonrpc: str = "2.0"
+    id: Optional[Any] = None
+    result: Optional[Any] = None
+    error: Optional[Dict[str, Any]] = None
+    
+    def json(self, **kwargs):
+        return self.model_dump_json(exclude_none=True, **kwargs)
+
+# ✅ PASSES - keeps required fields
+class JsonRpcResponse(BaseModel):
+    jsonrpc: str = "2.0"
+    id: Optional[Any] = None
+    result: Optional[Any] = None
+    error: Optional[Dict[str, Any]] = None
+    
+    def json(self, **kwargs):
+        data = self.model_dump()
+        # Keep id and jsonrpc always, only exclude result/error conditionally
+        if data.get('error') is not None:
+            data.pop('result', None)
+        elif data.get('result') is not None:
+            data.pop('error', None)
+        return json.dumps(data)
+```
+
+## API Usage
+
+### Python API
+```python
+from preflight_tools.mcp import MCPValidator
+
+validator = MCPValidator()
+
+# Validate a tools file
+results = validator.validate_file("path/to/tools.py")
+
+for issue in results.issues:
+    print(f"{issue.severity}: {issue.message}")
+    print(f"  Fix: {issue.suggestion}")
+
+# Test a running server
+results = validator.test_server("http://localhost:8000")
+print(f"Protocol version: {results.protocol_version}")
+print(f"Tools found: {len(results.tools)}")
+```
+
+### Configuration
+
+Create a `.preflight.toml` in your project root:
+```toml
+[mcp]
+strict = true  # Fail on warnings
+ignore = ["stdout-pollution"]  # Skip specific checks
+
+[a2a]
+version = "0.1.0"
+require_auth = true
+```
+
+## Development
+```bash
+# Clone and setup
+git clone https://github.com/syzygysys/preflight-tools.git
+cd preflight-tools
+poetry install
+
+# Run tests
+poetry run pytest
+
+# Run validator on itself
+poetry run mcp-preflight-check validate src/
+
+# Format and lint
+poetry run black src/ tests/
+poetry run ruff check src/ tests/
+poetry run mypy src/
+```
+
+## Architecture
+```
+preflight-tools/
+├── src/preflight_tools/
+│   ├── mcp/              # MCP validation
+│   │   ├── validator.py  # Core validation logic
+│   │   ├── checks.py     # Individual check implementations
+│   │   └── cli.py        # Command-line interface
+│   ├── a2a/              # A2A validation (coming soon)
+│   └── common/           # Shared utilities
+├── tests/
+│   ├── test_mcp.py
+│   └── fixtures/         # Test cases
+└── docs/
+    └── protocols/        # Protocol specs
+```
+
+## Contributing
+
+We welcome contributions! This is a reference implementation for the community.
+
+1. Fork the repo
+2. Create a feature branch
+3. Add tests for new validators
+4. Submit a PR with clear description
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Related Projects
+
+- [LAP::CORE](https://github.com/syzygysys/lap_core) - LAPI orchestration platform
+- [ACE Framework](https://github.com/syzygysys) - Autonomic Compliance Ecosystem
+- [MCP Specification](https://modelcontextprotocol.io/) - Official MCP docs
+
+## References
+
+- [Log 14: Debugging the Bridge](https://syzygysys.github.io/docs/architects_notebook/log_14.html) - The debugging session that inspired this tool
+- [MCP GitHub Issues](https://github.com/anthropics/mcp/issues) - Report MCP bugs here
+- [SyzygySys Architecture Notebook](https://syzygysys.github.io/docs/architects_notebook/) - More technical deep-dives
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.
+
+Copyright 2025 SyzygySys
+
+## Support
+
+- Issues: [GitHub Issues](https://github.com/syzygysys/preflight-tools/issues)
+- Discussions: [GitHub Discussions](https://github.com/syzygysys/preflight-tools/discussions)
+- Email: kevin@syzygysys.com
+
+---
+
+Built with ❤️ as a gift to the autonomous systems community.
+