Skip to content

fix: plugins template #783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 19, 2025
Merged

fix: plugins template #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fd46bd7
feat: update context forge target in template's project dependencies
araujof Aug 18, 2025
aa80775
fix: exclude jinja files from reformatting tabs
araujof Aug 19, 2025
938bb9f
fix: plugins cli defaults
araujof Aug 19, 2025
e9f82e5
fix: revert formatted Makefile template
araujof Aug 19, 2025
8d19e67
feat: add optional packages
araujof Aug 19, 2025
24e43b7
docs: update plugin template docs
araujof Aug 19, 2025
fa7b07f
docs: update template readme
araujof Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,8 +482,8 @@ repos:
- id: remove-tabs
name: 🚀 Remove Tabs
description: Replaces tabs by whitespaces.
# exclude root-level Makefiles and any path ending in /Makefile or .mk
exclude: '(^|/)Makefile$|\.mk$'
# exclude root-level Makefiles and any path ending in /Makefile or .mk or .jinja
exclude: '(^|/)Makefile$|(\.mk|\.jinja)$'

# -----------------------------------------------------------------------------
# 🚫 Branch Protection Hooks
Expand Down
12 changes: 11 additions & 1 deletion docs/docs/using/plugins/lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,17 @@ Inspect those two files and get familiar with them. There are many options you c

### Dependencies

Plugins are Python packages with dependencies managed by `uv`. Just like the gateway, you can add, lock, lint, and ensure that best practices are followed when creating your plugins. To ensure compatibility with the gateway linters, we do not directly install them in the template. Instead, please install the gateway package with the dev extras, which will include all required linters.
Plugins are Python packages with dependencies managed by `uv`. Just like the gateway, you can add, lock, lint, and ensure that best practices are followed when creating your plugins. To install dependencies with dev packages (required for linting and testing), run:

```bash
make install-dev
```

Alternatively, you can also install it in editable mode:

```bash
make install-editable
```

### Test

Expand Down
4 changes: 1 addition & 3 deletions mcpgateway/plugins/tools/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@
# ---------------------------------------------------------------------------
# Configuration defaults
# ---------------------------------------------------------------------------
DEFAULT_TEMPLATE_BASE_URL = "https://github.com/IBM/mcp-context-forge.git"
DEFAULT_TEMPLATE_TYPE = "external"
DEFAULT_TEMPLATE_URL = f"{DEFAULT_TEMPLATE_BASE_URL}::plugin_templates/{DEFAULT_TEMPLATE_TYPE}"
DEFAULT_TEMPLATE_URL = "https://github.com/IBM/mcp-context-forge.git"
DEFAULT_AUTHOR_NAME = "<changeme>"
DEFAULT_AUTHOR_EMAIL = "<changeme>"
DEFAULT_PROJECT_DIR = Path("./.")
Expand Down
Loading
Loading