core: add pytool management assets

Author: simonprovost

.gitignore

@@ -0,0 +1,63 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+wheelhouse/
+
+# Virtual environments
+.env
+.venv
+ENV/
+env/
+venv/
+
+# PyInstaller
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# macOS
+.DS_Store
+
+# IDEs
+.vscode/
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        name: ruff (lint)
+        args: [--fix, --show-fixes]
+      - id: ruff-format
+        name: ruff (format)
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-merge-conflict

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+# 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 community leaders responsible for enforcement at
+fairuse@nyu.edu.
+
+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
+

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# How to add new stuff to MCPStack-Tool?
+
+Hey there! Appreciated your venue here! Want to build stuff on top of MCPStack-Tool?
+
+## Prerequisites
+
+- Python 3.9+
+- [uv](https://docs.astral.sh/uv/) (preferred package/dependency manager)
+- `pre-commit` and `ruff`
+- Git (with your GitHub SSH set up if you push to a fork)
+
+## Setup
+
+Clone the repository and sync dependencies:
+
+```bash
+git clone git@github.com:<you>/mcpstack-tool.git
+cd mcpstack-tool
+uv sync --all-extras
+pre-commit install
+
+# uv automatically installs in editable mode.
+# To manage dependencies:
+
+uv add <package>      # add a package
+uv remove <package>   # remove a package
+uv lock               # update lockfile
+```
+
+See the uv documentation for installation instructions.
+
+Branches & Commits
+* Branch from main: feat/<slug>, fix/<slug>, chore/<slug>. 
+* Keep commits focused and descriptive. Conventional commits are welcome: feat:, fix:, chore:, docs:.
+
+Code Style
+* Ruff is the source of truth for linting and formatting (ruff + ruff format).
+* Line length: 100 (pyproject.toml).
+* Prefer readable code over clever code. Add comments if intent isn’t obvious.
+
+Tests
+* Add tests for behavior changes. Minimal repro-style tests are acceptable.
+* Keep test data lightweight and local.
+
+Running Checks
+
+```bash
+pre-commit run --all-files
+python -m mcpstack_tool.cli --health
+```
+
+PR Expectations
+* Fill out the PR template (if present).
+* Link to the issue you’re fixing.
+* Include logs or minimal repros when relevant.
+* Keep diffs reviewable. Split large changes into smaller PRs.
+
+Security
+* Never commit secrets or datasets.
+* Do not upload datasets to GitHub issues or pull requests. Use synthetic or anonymized examples when reporting bugs.
+* Report vulnerabilities privately first when possible.
+
+Thanks for contributing!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Simon Provost
+
+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.

SECURITY.md

@@ -0,0 +1,30 @@
+# Security Policy
+
+We take security seriously and encourage responsible disclosure.
+
+If you believe you’ve found a security vulnerability in **MCPStack-Tool**, please report it to us privately rather than opening a public issue.
+
+## Reporting a Vulnerability
+
+Include the following information in your report:
+
+- **Project**: <Repository URL> (e.g., From `https://github.com/MCP-Pipeline/MCPStack-Tool`)
+- **Public**: Has this issue already been disclosed elsewhere?
+- **Description**: A clear explanation of the vulnerability, with reproduction steps if possible.
+- **Environment**: Operating system, Python version, MCP client, and any relevant setup details.
+
+Send reports to: **simon.gilbert.provost@gmail.com** 
+
+We will acknowledge receipt within 7 days and aim to provide a resolution or mitigation timeline within 30 days. Please do not share vulnerabilities publicly until a fix has been released.
+
+## Scope and Considerations
+
+- **Tool Combinations**: MCPStack-Tool is designed to compose with other MCP tools. Unexpected or unsafe interactions between tools cannot be predicted or prevented at the MCPStack-Tool level. The responsibility for safe orchestration rests with the user.  
+- **Data Breach Risks**: MCPStack-Tool runs locally and does not send data to external services. There are no cloud communications by default, so conventional remote data breaches do not apply.  
+- **GitHub Issues and Pull Requests**: Do not upload sensitive data (such as private datasets, logs, or credentials) when filing issues or submitting pull requests. Use synthetic or anonymized examples instead.
+
+## Good Practices
+
+- Keep dependencies updated.  
+- Test tool compositions in a controlled environment.  
+- Sanitize any shared examples when discussing issues publicly.

pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+[project]
+name = "mcpstack-your-tool-name"
+version = "0.1.0"
+description = "Create your MCPStack tool with this template repository!"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "Provost Simon", email = "s.g.provost@kent.ac.uk" }]
+keywords = ["mcp", "mcpstack", "mcpPipeline", "tool", "template"]
+dependencies = [
+  "typer>=0.9.0",
+  "beartype>=0.21.0",
+  "rich>=13.0.0",
+  "rich-argparse>=1.4.0",
+  "mcpstack",
+  "rich-pyfiglet>=1.0.0",
+  "click>=8.1.8",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.4",
+  "ruff>=0.4.0",
+  "pre-commit>=3.0.0"
+]
+
+# Let MCPStack discover external tools via entry points
+[project.entry-points."mcpstack.tools"]
+your_tool_name = "mcpstack_your_tool_name.tool:YourTool"
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E","W","F","I","UP","RUF","B","C4"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+
+[tool.uv.sources]
+mcpstack = { path = "../../MCPStack" }