Skip to content

Commit 7b59267

Browse files
authored
feat: compose plugins and catalog config (#1174)
* feat: include settings for plugins and catalog Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> * docs: udpated plugin usage docs Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> * docs: reference plugin spec in arch overview page Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> --------- Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com>
1 parent 0d9a23e commit 7b59267

File tree

3 files changed

+23
-14
lines changed

3 files changed

+23
-14
lines changed

docker-compose.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ services:
7070
# - SSL=true
7171
# - CERT_FILE=/app/certs/cert.pem
7272
# - KEY_FILE=/app/certs/key.pem
73+
# Uncomment to enable plugins
74+
# - PLUGINS_ENABLED=true
75+
# Uncomment to enable catalog
76+
# - MCPGATEWAY_CATALOG_ENABLED=true
77+
# - MCPGATEWAY_CATALOG_FILE=/app/mcp-catalog.yml
7378

7479
# Phoenix Observability Integration (uncomment when using Phoenix)
7580
# - PHOENIX_ENDPOINT=${PHOENIX_ENDPOINT:-http://phoenix:6006}
@@ -96,6 +101,7 @@ services:
96101
start_period: 30s
97102

98103
# volumes:
104+
# - ./mcp-catalog.yml:/app/mcp-catalog.yml:ro # mount catalog configuration
99105
# - ./certs:/app/certs:ro # mount certs folder read-only (includes both SSL and JWT keys)
100106
#
101107
# For JWT asymmetric keys:

docs/docs/architecture/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ graph TD
5252
## Additional Architecture Documentation
5353

5454
- [Export/Import System Architecture](export-import-architecture.md) - Technical design of configuration management system
55+
- [Plugin Framework Specification](plugins.md) - Technical design of the gateway plugin system
5556

5657
## ADRs and Design Decisions
5758

docs/docs/using/plugins/index.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,22 @@ The MCP Context Forge Plugin Framework provides a comprehensive, production-grad
1616
- **Operational Excellence** - Health‑oriented design, clear errors, sensible defaults
1717
- **Enterprise Features** - Multi-tenant isolation, conditional execution, sophisticated context management
1818

19+
## Enabling Plugins
20+
21+
### Environment Configuration
22+
23+
Enable the plugin framework in your `.env` file:
24+
25+
```bash
26+
# Enable plugin framework
27+
PLUGINS_ENABLED=true
28+
29+
# Optional: Custom plugin config path
30+
PLUGIN_CONFIG_FILE=plugins/config.yaml
31+
```
32+
33+
If deploying the gateway as a container, set these environment variables in your compose file or in the container's `run` command.
34+
1935
## Architecture
2036

2137
!!! details "Plugin Framework Specification"
@@ -58,20 +74,6 @@ class Plugin:
5874
# ... additional hook methods
5975
```
6076

61-
## Enabling Plugins
62-
63-
### Environment Configuration
64-
65-
Enable the plugin framework in your `.env` file:
66-
67-
```bash
68-
# Enable plugin framework
69-
PLUGINS_ENABLED=true
70-
71-
# Optional: Custom plugin config path
72-
PLUGIN_CONFIG_FILE=plugins/config.yaml
73-
```
74-
7577
## Build Your First Plugin (Quickstart)
7678

7779
Decide between a native (in‑process) or external (MCP) plugin:

0 commit comments

Comments
 (0)