Skip to content

docs: treat microlink skill as the only entry point #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kikobeats merged 1 commit into from
Sep 21, 2026
Merged

docs: treat microlink skill as the only entry point #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Agents

Product docs for agents live in [microlinkhq/skills](https://github.com/microlinkhq/skills), not only in this repo's READMEs.
Product docs for agents live in [microlinkhq/skills](https://github.com/microlinkhq/skills). **`microlink/SKILL.md` is the only entry point** — users add `microlinkhq/skills/microlink`. That skill opens companions when needed; do not ship them as separate products.

When a change here would change how an agent calls Microlink, update the matching skill in the same effort (sibling checkout `../skills`, or a PR to that repo). Do not ship a removed or renamed API while the skill still documents the old one.

| Change in | Update |
| --- | --- |
| `packages/core`, `packages/function`, `packages/search`, root `README.md` | `microlink/SKILL.md` |
| `packages/mcp` | `microlink-mcp/SKILL.md` (runtime sheet) and the "In the assistant" section of `microlink/SKILL.md` |
| HTTP query params, embed URLs, extract/function grammar | `microlink-api/SKILL.md` and `microlink-api/api-reference.md` |
| `packages/core`, `packages/function`, `packages/search`, root `README.md` | `microlink/SKILL.md` (keep the companion routing table current) |
| `packages/mcp` | `microlink-mcp/SKILL.md` and the "In the assistant" section of `microlink/SKILL.md` |
| HTTP query params, embed URLs, extract/function grammar | `microlink-api/SKILL.md`, `microlink-api/api-reference.md`, and the companion row in `microlink/SKILL.md` |

That includes product methods, options, return types (including nullability), CLI commands/flags, MCP tools/config/errors, auth, and plan limits.
Loading