Contributing to mcp-nfe-br

Thank you for your interest in contributing. This document explains the workflow and expectations.

Development setup

git clone https://github.com/cmendezs/mcp-nfe-br.git
cd mcp-nfe-br
uv sync --all-extras

Running the test suite

uv run pytest

Run with verbose output:

uv run pytest -v

Linting and type checking

uv run ruff check src/mcp_nfe_br/ tests/ audit/
uv run ruff format --check src/mcp_nfe_br/ tests/ audit/
uv run mypy src

To auto-fix lint issues:

uv run ruff check --fix src/mcp_nfe_br/ tests/ audit/
uv run ruff format src/mcp_nfe_br/ tests/ audit/

Tool reference

The tool reference in docs/TOOLS.md is generated from the running MCP server. If you add, remove, or change a tool or its parameters, regenerate it:

uv run python scripts/gen_tool_reference.py

The publish workflow regenerates it at release time, and --check mode reports drift without writing:

uv run python scripts/gen_tool_reference.py --check

Pull request checklist

• All tests pass (pytest)
• No lint errors (ruff check)
• No type errors (mypy src)
• New or changed behaviour is covered by tests
• Validation fixes reference the relevant rule ID (e.g. RV 6.001)
• docs/TOOLS.md regenerated if any tool or parameter changed
• CHANGELOG.md updated under [Unreleased]

Commit style

Use Conventional Commits:

feat: add a new validation tool
fix: normalize party identifiers with leading zeros
docs: update README with configuration details
test: add fixture for a credit note

Reporting issues

Please open an issue at https://github.com/cmendezs/mcp-nfe-br/issues and include:

• The tool name and input you used
• The expected result
• The actual result (full error message or unexpected output)
• The national e-invoicing standard or rule ID involved, if known

Security issues follow a different path: see SECURITY.md and report privately rather than in a public issue.