Skip to content

Commit afba142

Browse files
authored
docs: update plugins dev workflow (#791)
* docs: update plugins dev workflow Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> * docs: update plugins dev workflow diagram Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> * docs: minor change Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com> --------- Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com>
1 parent 092ef78 commit afba142

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/docs/using/plugins/lifecycle.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ The plugin framework includes CLI tools to help you create, test, and deploy you
44

55
## Development Flow
66

7+
The plugin development workflow follows a straightforward workflow that gets you from idea to running plugin quickly.
8+
79
```mermaid
8-
flowchart LR
10+
graph LR
911
1012
A["template"]
1113
B(["$> bootstrap"])
@@ -22,9 +24,23 @@ flowchart LR
2224
2325
B --> C
2426
27+
subgraph CF["Context Forge"]
28+
E["gateway"]
29+
D o--"MCP<br>&nbsp;&nbsp;<small>tools/call <i>hook</i></small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"--o E
30+
end
31+
2532
style A stroke-dasharray: 3 3;
2633
```
2734

35+
The process breaks down into these main steps:
36+
37+
- **Bootstrap**: Start with a plugin template and run the bootstrap command to set up your project structure
38+
- **Build**: Compile and package your plugin code
39+
- **Serve**: Launch a local development server to test your plugin
40+
- **Connect**: Your served plugin automatically integrates with Context Forge's gateway via MCP (Model Context Protocol), using tool calls over standardized hooks for seamless communication
41+
42+
This streamlined approach lets developers focus on building functionality rather than wrestling with configuration, while ensuring plugins work smoothly within the broader Context Forge ecosystem.
43+
2844
### Bootstrap
2945

3046
Creating a new plugin for Context Forge only takes a few minutes!

0 commit comments

Comments
 (0)