Skip to content

Commit 933f11c

Browse files
authored
docs: revise and consolidate plugin specification and design docs (#1139)
* docs: fix inconsistencies Signed-off-by: Frederico Araujo <[email protected]> * docs: revise and refactor plugin specification docs Signed-off-by: Frederico Araujo <[email protected]> * docs: update adr references Signed-off-by: Frederico Araujo <[email protected]> * docs: update toc Signed-off-by: Frederico Araujo <[email protected]> * docs: update nav Signed-off-by: Frederico Araujo <[email protected]> * docs: update plugins spec Signed-off-by: Frederico Araujo <[email protected]> * docs: update diagrams Signed-off-by: Frederico Araujo <[email protected]> --------- Signed-off-by: Frederico Araujo <[email protected]>
1 parent 8fd3658 commit 933f11c

19 files changed

+1186
-3048
lines changed

docs/docs/architecture/.pages

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ nav:
22
- Overview: index.md
33
- Roadmap: roadmap.md
44
- Security Features: security-features.md
5-
- Plugin Framework: plugins.md
6-
- Plugin Specification: plugin-spec
5+
- Plugin Framework: plugins.md
76
- Export-Import Architecture: export-import-architecture.md
87
- Multitenancy: multitenancy.md
98
- OAuth: oauth-design.md
109
- OAuth UI: oauth-authorization-code-ui-design.md
1110
- Decision Records: adr
11+

docs/docs/architecture/adr/016-plugin-framework-ai-middleware.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
- **Status:** Implemented
44
- **Date:** 2025-01-19
5-
- **Deciders:** Mihai Criveti, Teryl Taylor
6-
- **Technical Story:** [#313](https://github.com/anthropics/mcp-context-forge/issues/313), [#319](https://github.com/anthropics/mcp-context-forge/issues/319), [#673](https://github.com/anthropics/mcp-context-forge/issues/673)
5+
- **Deciders:** Mihai Criveti, Teryl Taylor, Fred Araujo
6+
- **Technical Story:** [#313](https://github.com/IBM/mcp-context-forge/issues/313), [#319](https://github.com/IBM/mcp-context-forge/issues/319), [#673](https://github.com/IBM/mcp-context-forge/issues/673), [#773](https://github.com/IBM/mcp-context-forge/issues/773), [#720](https://github.com/IBM/mcp-context-forge/issues/720)
77

88
## Context
99

10-
The MCP Gateway required a robust plugin framework to support AI safety middleware, security processing, and extensible gateway capabilities. The implementation needed to support both self-contained plugins (running in-process) and external middleware service integrations while maintaining performance, security, and operational simplicity.
10+
The MCP Gateway required a robust plugin framework to support AI safety middleware, security processing, and extensible gateway capabilities. The implementation needed to support both native plugins (running in-process) and external middleware service integrations while maintaining performance, security, and operational simplicity.
1111

1212
## Decision
1313

@@ -229,7 +229,7 @@ sequenceDiagram
229229

230230
## Performance Characteristics
231231

232-
- **Latency Impact:** Self-contained plugins add <1ms overhead per hook
232+
- **Latency Impact:** Native plugins add <1ms overhead per hook
233233
- **Memory Usage:** ~5MB base overhead, scales linearly with active plugins
234234
- **Throughput:** Tested to 1000+ req/s with 5 active plugins
235235
- **Context Cleanup:** Automatic cleanup every 5 minutes, contexts expire after 1 hour
@@ -279,7 +279,7 @@ sequenceDiagram
279279

280280
### Positive
281281
**Complete AI Safety Pipeline:** Framework supports end-to-end content filtering and safety
282-
**High Performance:** Self-contained plugins provide sub-millisecond latency
282+
**High Performance:** Native plugins provide sub-millisecond latency
283283
**Operational Simplicity:** File-based configuration integrates with existing workflows
284284
**Future-Proof:** Architecture supports both current needs and roadmap expansion
285285
**Security-First:** Multiple layers of protection against malicious plugins and inputs
@@ -291,7 +291,7 @@ sequenceDiagram
291291
**Debugging Challenges:** Sequential plugin chains can be difficult to troubleshoot
292292

293293
### Neutral
294-
🔄 **Hybrid Architecture:** Both self-contained and external services require different operational approaches
294+
🔄 **Hybrid Architecture:** Both native and external services require different operational approaches
295295
🔄 **Memory Usage:** Plugin contexts require careful management in high-traffic environments
296296
🔄 **Performance Tuning:** Plugin timeouts and priorities need environment-specific tuning
297297

docs/docs/architecture/plugin-spec/.pages

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/docs/architecture/plugin-spec/01-architecture.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

docs/docs/architecture/plugin-spec/02-core-components.md

Lines changed: 0 additions & 124 deletions
This file was deleted.

0 commit comments

Comments
 (0)