mcp-resk 0.1.0__tar.gz

mcp_resk-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.

mcp_resk-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include README.md
+include requirements.txt
+include config.yaml.example
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.so
+global-exclude .git* 

mcp_resk-0.1.0/Notice

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anthropic, PBC
+
+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.

mcp_resk-0.1.0/PKG-INFO

@@ -0,0 +1,339 @@
+Metadata-Version: 2.4
+Name: mcp-resk
+Version: 0.1.0
+Summary: RESK-MCP is an open-source Python library designed to add a robust security and management layer over the official MCP Library.
+Author-email: RESK Team <your.email@example.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/your-username/mcp-resk
+Project-URL: Bug Tracker, https://github.com/your-username/mcp-resk/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: Notice
+Requires-Dist: fastapi>=0.115.12
+Requires-Dist: mcp[cli]>=1.9.0
+Requires-Dist: pydantic>=2.11.4
+Requires-Dist: pyjwt[crypto]>=2.10.1
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: requests>=2.32.3
+Requires-Dist: slowapi>=0.1.9
+Requires-Dist: types-pyyaml>=6.0.12.20250516
+Requires-Dist: uvicorn>=0.34.2
+Dynamic: license-file
+
+# RESK-MCP: Secure Model Context Protocol Layer
+
+[![PyPI version](https://img.shields.io/pypi/v/mcp-resk.svg)](https://pypi.org/project/mcp-resk/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/mcp-resk.svg)](https://pypi.org/project/mcp-resk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/mcp-resk)](https://pepy.tech/project/mcp-resk)
+[![GitHub issues](https://img.shields.io/github/issues/Resk-Security/mcp-resk.svg)](https://github.com/Resk-Security/mcp-resk/issues)
+[![GitHub Stars](https://img.shields.io/github/stars/Resk-Security/mcp-resk?style=social)](https://github.com/Resk-Security/mcp-resk/stargazers)
+[![GitHub Forks](https://img.shields.io/github/forks/Resk-Security/mcp-resk?style=social)](https://github.com/Resk-Security/mcp-resk/network/members)
+[![Documentation Status](https://readthedocs.org/projects/mcp-resk/badge/?version=latest)](https://mcp-resk.readthedocs.io/en/latest/?badge=latest)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![GitHub last commit](https://img.shields.io/github/last-commit/Resk-Security/mcp-resk.svg)](https://github.com/Resk-Security/mcp-resk/commits/main)
+[![PyPI - Implementation](https://img.shields.io/pypi/implementation/mcp-resk.svg)](https://pypi.org/project/mcp-resk/)
+[![LLM Security](https://img.shields.io/badge/LLM%20Security-Enhanced-brightgreen.svg)](https://github.com/Resk-Security/mcp-resk)
+
+RESK-MCP is an open-source Python library that adds a robust security and management layer over the official [Model Context Protocol (MCP) Python SDK](https://github.com/modelcontextprotocol/python-sdk). It provides enhanced security features, monitoring capabilities, and tools for managing MCP interactions.
+
+
+## Features
+
+
+- **JWT Authentication**: Secure MCP server endpoints with JSON Web Tokens
+- **Input Validation**: Validate all incoming MCP requests using Pydantic
+- **PII Detection**: Basic detection of Personally Identifiable Information in request parameters
+- **Prompt Injection Protection**: Detection of common prompt injection phrases
+- **Rate Limiting**: Configurable per-user or per-IP rate limits using `slowapi`
+- **Token-Based Context Management**: Limit request size based on estimated token count
+- **Interaction Tracking**: Monitor calls to tools, resources, and prompts
+- **Dashboard**: Web-based visualization of MCP interactions and server configuration
+- **Easy Configuration**: Simple setup using environment variables
+- **HTTPS Support**: Built-in SSL/TLS configuration
+
+## Installation
+
+```bash
+# Clone the repository (if contributing or running from source)
+git clone https://github.com/Resk-Security/mcp-resk.git
+cd mcp-resk
+
+# Create and activate virtual environment
+python -m venv venv
+
+# On Windows
+# .\venv\Scripts\activate
+
+# On macOS/Linux
+# source venv/bin/activate
+
+# Install dependencies using uv (recommended)
+uv pip install -r requirements.txt
+
+# For development with editable install
+uv pip install -e .
+
+# If contributing or running tests
+uv pip install -e ".[dev]"
+```
+
+> **Note**: We use [uv](https://github.com/astral-sh/uv) as the recommended package installer because it's significantly faster than pip and provides better dependency resolution. It's also used in our CI/CD workflow.
+
+## Configuration
+
+Create a `.env` file in your project root:
+
+```env
+# Required
+JWT_SECRET="your-super-secure-jwt-secret-key-here"
+
+# Optional configurations
+RATE_LIMIT="100/minute"  # Format: "count/period" (e.g., "5/second", "1000/hour")
+MAX_TOKEN_PER_REQUEST="4000"
+LOG_LEVEL="INFO"
+
+# For HTTPS
+# SSL_KEYFILE="./key.pem"
+# SSL_CERTFILE="./cert.pem"
+```
+
+### ⚠️ JWT Security Warning
+
+The security of your MCP server relies heavily on the strength of your JWT secret:
+
+- **NEVER** use simple, predictable, or default JWT secrets in production
+- Use a strong, randomly generated secret with high entropy (at least 32 characters)
+- Do not store JWT secrets in your code or commit them to version control
+- Rotate JWT secrets periodically in production environments
+- Consider using environment-specific secrets for different deployments
+- If you suspect a JWT secret has been compromised, rotate it immediately
+
+The `JWT_SECRET` is used to sign and verify all authentication tokens. A compromised secret would allow attackers to forge valid tokens and bypass your authentication system entirely.
+
+## Usage Example
+
+```python
+# main.py
+import os
+from dotenv import load_dotenv
+from resk_mcp import SecureMCPServer, create_jwt_token
+
+load_dotenv()
+
+# Initialize the secure server
+server = SecureMCPServer(name="MySecureCalculatorApp")
+
+# Define a sample tool
+@server.tool(name="calculator/add")
+async def add(a: int, b: int) -> int:
+    """Adds two numbers."""
+    return a + b
+
+@server.resource(path_pattern="info/version")
+async def get_version() -> dict:
+    """Returns the application version."""
+    return {"version": "1.0-secure"}
+
+if __name__ == "__main__":
+    # Generate a test token
+    jwt_secret = os.getenv("JWT_SECRET")
+    if not jwt_secret:
+        print("Error: JWT_SECRET not found. Please set it in .env file.")
+        exit(1)
+    
+    test_user_id = "user@example.com"
+    token = create_jwt_token(user_id=test_user_id, secret_key=jwt_secret)
+    print(f"Test Token: Bearer {token}\n")
+
+    # Start the server
+    ssl_key_path = os.getenv("SSL_KEYFILE")
+    ssl_cert_path = os.getenv("SSL_CERTFILE")
+    
+    if ssl_key_path and ssl_cert_path:
+        server.run_server(port=8001, ssl_keyfile=ssl_key_path, ssl_certfile=ssl_cert_path)
+    else:
+        server.run_server(port=8001)
+```
+
+## Troubleshooting
+
+### JWT Authentication: "Signature verification failed"
+
+If you encounter `WARNING:resk_mcp.server:Authentication failed for /mcp_secure: Invalid token: Signature verification failed` errors when running test_client.py against example_server.py, it means the JWT (JSON Web Token) sent by the client could not be verified by the server. This almost always indicates a mismatch in the JWT_SECRET used to sign the token (client-side or how the token was originally generated) and the JWT_SECRET used by the server to verify it.
+
+#### How JWT Authentication is Setup in this Example:
+
+**Server-Side (example_server.py):**
+
+- The server relies on a JWT_SECRET for signing and verifying tokens.
+- This secret is primarily configured via a .env file at the root of the project. The resk_mcp/config.py module loads this secret into the application's settings (settings.jwt_secret).
+- When example_server.py starts, it generates a test JWT using this settings.jwt_secret and prints it to the console. This is the token your test_client.py should be using.
+
+**Client-Side (test_client.py):**
+
+- The test_client.py has a hardcoded AUTH_TOKEN variable.
+- This token is sent in the Authorization header for requests to the secure MCP endpoint.
+
+#### The Mismatch:
+
+The "Signature verification failed" error occurs if the AUTH_TOKEN in test_client.py was not generated using the exact same JWT_SECRET that example_server.py is currently configured with (via its .env file).
+
+#### How to Fix It:
+
+**Ensure JWT_SECRET is Configured for the Server:**
+
+1. Create a file named .env in the root directory of this project (e.g., alongside example_server.py).
+2. Add your desired secret key to it:
+   ```
+   JWT_SECRET="your_very_strong_and_unique_secret_key_here"
+   ```
+3. Important: If you change this secret, any previously generated tokens (including the one in test_client.py) will become invalid.
+
+**Run the Server (example_server.py):**
+
+Execute `python example_server.py`.
+
+**Copy the Correct Token from Server Logs:**
+
+1. Look for a log message from the server similar to this:
+   ```
+   INFO:example-server:Token de test généré (utilisant JWT_SECRET du .env): eyJhbGciOiJIUzI1NiI...[long_token_string]...
+   ```
+   (The message might be slightly different if you changed the log language/format, but it will contain the generated token.)
+2. Carefully copy the entire token string (it's usually very long).
+
+**Update test_client.py:**
+
+1. Open test_client.py.
+2. Find the line:
+   ```python
+   AUTH_TOKEN = "some_old_or_incorrect_token_here"
+   ```
+3. Replace the old token string with the new token you just copied from the server logs.
+   ```python
+   AUTH_TOKEN = "eyJhbGciOiJIUzI1NiI...[the_new_long_token_string_you_copied]..."
+   ```
+
+**Run the Client (test_client.py):**
+
+Now, execute `python test_client.py`.
+The authentication errors should be gone, and your client should be able to communicate with the server successfully.
+
+**Key Takeaway:** The AUTH_TOKEN used by the client must be a token that was signed with the exact same JWT_SECRET that the server is currently using for verification. The easiest way to ensure this in this example setup is to always use the token printed by example_server.py on startup.
+
+## Detailed Configuration
+
+RESK-MCP uses environment variables for configuration. Create a `.env` file in the root of your project with the following (at a minimum):
+
+```env
+# .env
+JWT_SECRET="your-super-secure-jwt-secret-key-here"
+
+# Rate Limiting (default: "100/minute")
+# Examples: "5/second", "1000/hour", "20/day"
+RATE_LIMIT="100/minute"
+
+# Optional for HTTPS:
+# SSL_KEYFILE="./key.pem"
+# SSL_CERTFILE="./cert.pem"
+
+# Optional for context management and logging:
+# MAX_TOKEN_PER_REQUEST="4000"
+# LOG_LEVEL="INFO"
+```
+
+- **JWT_SECRET**: A strong, random secret key for signing JWT tokens. This is critical for security.
+- **RATE_LIMIT**: Defines the rate limit for requests. The format is count/period (e.g., 100/minute, 5/second). Defaults to 100/minute. Rate limiting is primarily based on the user_id from the JWT, falling back to IP address if the token is invalid or missing.
+- **SSL_KEYFILE**: Path to your SSL private key file (e.g., key.pem).
+- **SSL_CERTFILE**: Path to your SSL certificate file (e.g., cert.pem).
+- **MAX_TOKEN_PER_REQUEST**: Approximate maximum tokens allowed per request (default: 4000).
+- **LOG_LEVEL**: Logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL, default: INFO).
+
+### Generating SSL Certificates (for HTTPS)
+
+For local development, you can generate self-signed certificates using OpenSSL:
+
+```bash
+openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 365 -nodes -subj "/CN=localhost"
+```
+
+For production, obtain certificates from a trusted Certificate Authority (CA) like Let's Encrypt.
+
+## Dashboard
+
+Access the analytics dashboard at `http://localhost:8001/dashboard`. It provides:
+
+- Real-time visualization of MCP interactions
+- Server configuration details
+- Lists of registered tools, resources, and prompts
+
+![Dashboard Server Info](static/images/dashboard-server-info.png)
+
+## Testing
+
+```bash
+# Run tests
+uv run pytest
+
+# Run all checks (linting, type checking, tests)
+python run_checks.py
+```
+
+## Project Structure
+
+```
+resk-mcp/
+├── resk_mcp/                 # Main library code
+│   ├── server.py             # SecureMCPServer implementation
+│   ├── auth.py               # JWT authentication
+│   ├── validation.py         # Input validation and security
+│   ├── context.py            # Context management
+│   └── dashboard.py          # Dashboard routes
+├── static/                   # Dashboard UI assets
+├── tests/                    # Test suite
+├── .env.example              # Example configuration
+├── requirements.txt          # Dependencies
+└── README.md
+```
+
+## CI/CD Workflow
+
+This project uses GitHub Actions for continuous integration and deployment:
+
+- **Automated Testing**: All pushes and PRs to the `main` branch trigger tests on Python 3.9 and 3.10
+- **Code Quality**: Includes linting with flake8 and type checking with mypy
+- **Package Publishing**: Tagged versions (format `v*`) are automatically published to PyPI
+- **Release Creation**: GitHub Releases are automatically created for each tagged version
+
+The workflow configuration is defined in `.github/workflows/python-package.yml`.
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to your branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+> **Note**: This project uses `main` as the default branch. All PRs should be made against the `main` branch.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Disclaimer
+
+This library provides basic security features. For production systems, ensure comprehensive security audits and consider more advanced techniques for PII and prompt injection detection tailored to your specific use case.