https://github.com/converged-computing/flux-mcp-server
Prototype MCP server for Flux tools (under development)
https://github.com/converged-computing/flux-mcp-server
Last synced: 5 months ago
JSON representation
Prototype MCP server for Flux tools (under development)
- Host: GitHub
- URL: https://github.com/converged-computing/flux-mcp-server
- Owner: converged-computing
- License: mit
- Created: 2025-12-18T07:55:26.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-19T08:00:30.000Z (6 months ago)
- Last Synced: 2025-12-22T02:38:45.726Z (6 months ago)
- Language: Python
- Size: 1.23 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# flux-mcp server
> 🌀 Service to deploy functions for MCP tools for Flux Framework
This library uses [flux-mcp](https://github.com/converged-computing/flux-mcp)
See [design thinking](docs/design.md) for an overview of design.
## Usage
This server is currently expected to be deployed on a cluster, alongside a Flux instance.
This means you need flux-python (comes packaged with Flux, or `pip install flux-python==`).
### Flux Instance
Let's mock a flux instance. Do a flux start in your terminal:
```bash
flux start
```
Get the `FLUX_URI` so we can connect from another terminal.
```bash
echo $FLUX_URI
```
### Server
To start the demo server, either will work:
```bash
flux-mcp-server
# or
python3 -m flux_mcp_server.server
```
Next we can run a test that will submit a job, and then view the event (that was saved to our database).
In a different terminal, export the `$FLUX_URI` you saw above.
```bash
export FLUX_URI=local:///tmp/flux-aG87Ma/local-0
```
Now run the little demo:
```bash
python3 ./tests/test_submit.py
```
```console
✅ Job ID: 359735320641536
⏳ Waiting for events to propagate to DB...
found 1 events: {'submit'}
found 7 events: {'start', 'submit', 'depend', 'alloc', 'priority', 'validate', 'annotations'}
found 7 events: {'start', 'submit', 'depend', 'alloc', 'priority', 'validate', 'annotations'}
found 11 events: {'start', 'submit', 'free', 'depend', 'finish', 'alloc', 'priority', 'validate', 'release', 'clean', 'annotations'}
📊 Event Log Analysis:
✅ Success! Recorded 11 events for Job 359735320641536.
- [SUBMIT]
- [VALIDATE]
- [DEPEND]
- [PRIORITY]
- [ANNOTATIONS]
- [ALLOC]
- [START]
- [FINISH]
- [RELEASE]
- [FREE]
- [CLEAN]
```
### Development
```bash
apt-get install -y python3-build
pyproject-build
```
### Todo
- [x] Fastmcp endpoint serving Flux MCP functions
- [x] Handle should receive events and write to database
- [x] Database should be interface (and flexible to different ones)
- sqlalchemy
- [ ] Auth should also be interface with different backends
- Most basic is "none" that just uses the Flux handle.
- Next is simple token, should be implemented as middleware of fastmcp
- Then OAuth2
- Then (custom) something with passing OAuth2-like to submit as a Flux user.
- [x] Example: user manually submits a job, can query database for state
- [ ] Example: Agent submits work, and can find state later.
- [ ] Migrate to container, then Flux Operator / Kubernetes service.
- [ ] Tests in CI and automated build.
## License
HPCIC DevTools is distributed under the terms of the MIT license.
All new contributions must be made under this license.
See [LICENSE](https://github.com/converged-computing/cloud-select/blob/main/LICENSE),
[COPYRIGHT](https://github.com/converged-computing/cloud-select/blob/main/COPYRIGHT), and
[NOTICE](https://github.com/converged-computing/cloud-select/blob/main/NOTICE) for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE- 842614