Skip to content

Commit 732385a

Browse files
author
AutomateLab
committed
community: add SECURITY.md and CONTRIBUTING.md
Quality signals for marketplace reviewers and contributors.
1 parent 925a6f7 commit 732385a

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to n8n-mcp
2+
3+
Thanks for your interest. This is a focused MCP server - we value quality over breadth. Read this before opening a PR.
4+
5+
## What we accept
6+
7+
- Bug fixes for existing tools
8+
- Lint rules for n8n failure modes not yet covered (see `references/lint-rules.md`)
9+
- Documentation improvements
10+
- Test coverage
11+
12+
We are cautious about adding new tools - each one must encode a failure mode that AI agents reliably hit and can't recover from without server-side help.
13+
14+
## Dev setup
15+
16+
**Requirements:** Node >= 20, npm
17+
18+
```bash
19+
git clone https://github.com/ratamaha-git/n8n-mcp.git
20+
cd n8n-mcp
21+
npm install
22+
npm run build
23+
```
24+
25+
Run the smoke test to verify the build:
26+
27+
```bash
28+
npm run smoke
29+
```
30+
31+
## Making changes
32+
33+
1. Fork the repo and create a branch from `main`
34+
2. Make your change - surgical edits only, match existing style
35+
3. Run `npm run build` - must compile cleanly
36+
4. Run `npm run smoke` - must pass
37+
5. Open a PR against `main`
38+
39+
## PR checklist
40+
41+
- [ ] `npm run build` passes
42+
- [ ] `npm run smoke` passes
43+
- [ ] New lint rules include a test case in the PR description (before/after workflow JSON)
44+
- [ ] No new dependencies added without discussion
45+
46+
## Commit style
47+
48+
Short imperative subject line, no period. Examples:
49+
50+
```
51+
fix: handle missing typeVersion in lint
52+
feat: add n8n_validate_credentials tool
53+
docs: clarify AI Agent connection model
54+
```
55+
56+
## Questions
57+
58+
Open a GitHub issue or email [email protected].

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| 0.3.x | Yes |
8+
| < 0.3 | No |
9+
10+
## Reporting a Vulnerability
11+
12+
If you find a security issue in n8n-mcp, please **do not open a public GitHub issue**.
13+
14+
Report it privately by emailing: **[email protected]**
15+
16+
Include:
17+
- A description of the vulnerability
18+
- Steps to reproduce
19+
- Potential impact
20+
- Any suggested fix (optional)
21+
22+
We will acknowledge your report within 48 hours and aim to ship a patch within 14 days for confirmed issues. We will credit reporters in the release notes unless you request otherwise.
23+
24+
## Scope
25+
26+
This MCP server runs locally on the user's machine and communicates with a local or self-hosted n8n instance. The attack surface is limited - there is no authentication layer, no remote code execution surface, and no user data stored. The main risk areas are:
27+
28+
- Improper handling of workflow JSON from untrusted sources
29+
- Credentials passed via environment variables (`N8N_API_URL`, `N8N_API_KEY`) exposed through process inspection
30+
31+
Out of scope: issues in n8n itself, MCP host applications (Claude, Cursor), or the user's n8n instance.

0 commit comments

Comments
 (0)