Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (67 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

89 lines (67 loc) · 2.75 KB


MCPStack Tool
MCPStack Tool Builder

A Template To Fasten The Creation of MCP-Stack MCP Tools

Important

If you have not been across the MCPStack main orchestrator repository, please start there: View Org

Want To Improve This Template?

Hey there! Appreciated your venue here! Want to build stuff on top of MCPStack-Tool-Builder?

Prerequisites

  • Python 3.9+
  • 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:

git clone https://github.com/MCP-Pipeline/MCPStack-Tool-Builder.git
cd MCPStack-Tool-Builder
uv sync --all-extras
uv run 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/, fix/, chore/.
  • 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

uv run pre-commit run --all-files

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!