File tree Expand file tree Collapse file tree 2 files changed +32
-25
lines changed Expand file tree Collapse file tree 2 files changed +32
-25
lines changed Original file line number Diff line number Diff line change 55
66## Installation
77
8+ ```bash
9+ make install
10+ ```
811
912## Setting up the development environment
1013
14+ 1. Copy .env.template .env
15+ 2. Enable plugins in `.env`
1116
1217## Testing
1318
1419Test modules are created under the `tests` directory.
1520
1621To run all tests, use the following command:
1722
18- ```
23+ ```bash
1924make test
2025```
2126
@@ -25,6 +30,28 @@ make test
2530
2631Before checking in any code for the project, please lint the code. This can be done using:
2732
28- ```
33+ ```bash
2934make lint-fix
3035```
36+
37+ ## Runtime (server)
38+
39+ This project uses [chuck-mcp-runtime](https://github.com/chrishayuk/chuk-mcp-runtime) to run external plugins as a standardized MCP server.
40+
41+ To build the container image:
42+
43+ ```bash
44+ make build
45+ ```
46+
47+ To run the container:
48+
49+ ```bash
50+ make start
51+ ```
52+
53+ To stop the container:
54+
55+ ```bash
56+ make stop
57+ ```
Original file line number Diff line number Diff line change 55
66## Installation
77
8-
9- ## Setting up the development environment
10-
11-
12- ## Testing
13-
14- Test modules are created under the `tests` directory.
15-
16- To run all tests, use the following command:
17-
18- ```
19- make test
20- ```
21-
22- **Note:** To enable logging, set `log_cli = true` in `tests/pytest.ini`.
23-
24- ## Code Linting
25-
26- Before checking in any code for the project, please lint the code. This can be done using:
27-
28- ```
29- make lint-fix
30- ```
8+ 1. Copy .env.example .env
9+ 2. Enable plugins in `.env`
10+ 3. Add the plugin configuration to `plugins/config.yaml`:
You can’t perform that action at this time.
0 commit comments