AlgoForgeSkill/README.md

83 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2026-08-14 23:45:01 +00:00
<p align="center">
<img src="https://img.shields.io/badge/Language-MQL5-1B6CA8?style=flat-square"/>
<img src="https://img.shields.io/badge/Platform-MetaTrader%205-0D1B2A?style=flat-square"/>
<img src="https://img.shields.io/badge/Author-nique__372-C9D6DF?style=flat-square&logoColor=white"/>
<img src="https://img.shields.io/badge/MQL5.com-nique__372-1B6CA8?style=flat-square"/>
<a href="./LICENSE">
<img src="https://img.shields.io/badge/License-MIT-blue.svg"/>
</a>
</p>
2026-08-14 22:34:07 +00:00
2026-08-14 23:45:01 +00:00
<p align="center">
A Agent Skill for working with [MQL5 Algo Forge](https://forge.mql5.io).
Instead of hardcoding a fixed list of endpoints, this skill teaches at your ai
to download the instance's own OpenAPI spec, search it locally, and query
it so it stays correct even as the API evolves.
</p>
## Main Features
- Downloads and caches the instance's `swagger.v1.json` spec (once per
session, refreshed hourly)
- Searches the spec by keyword instead of guessing or memorizing endpoint
paths
- Tests whether a given endpoint is public or requires a token, rather
than assuming
- Handles token setup safely (env var or `.env`), with guidance for
bash/zsh, PowerShell, and CMD
- Works the same on Linux, macOS, and Windows all the request/caching
logic is plain Python
## Repository Structure
```
AlgoForgeSkill/
├── SKILL.md # instructions for yor ai reads to use this skill
└── scripts/
├── swagger_client.py # download/cache/search the API spec used as-is
└── api_request_example.py # template for making a request adapt per endpoint
```
## Installation
### Claude.ai (Example)
Upload this folder (or a zip of it) as a custom skill. See
[Anthropic's skills documentation](https://docs.claude.com) for the
current upload flow.
---
## Quick Start
Once installed, just mention Algo Forge, `forge.mql5.io`, or a Forgejo/Gitea
task in your prompt Ai will pick up the skill automatically. For
example:
> "List the recent Actions runs for the `example-org/example-repo` repo
> on Algo Forge"
> "Search Algo Forge for public repos related to 'grid trading'"
If a task needs an authenticated endpoint, Claude will ask you to set a
`FORGEJO_TOKEN` environment variable (or a local `.env` file) it will
never ask you to paste the token directly into the chat, and it won't
write the token value into any file or response.
---
## License
**[Read Full License](./LICENSE)**
By downloading or using this repository, you accept the license terms.
---
## Contact
- **Platform:** [MQL5 Community](https://www.mql5.com/es/users/nique_372)
- **Profile:** https://www.mql5.com/es/users/nique_372
- **Articles:** https://www.mql5.com/es/users/nique_372/publications