Skip to content

Agent skill sync with docs: add mint test, Speakeasy SDK examples #7253

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

Open
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Agent skill sync with docs: add mint test, Speakeasy SDK examples #7253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e193ec4
docs: sync agent skill with mint test command and Speakeasy SDK examples
mintlify[bot] Sep 4, 2026
8d38a56
docs: use active voice in x-codeSamples Speakeasy note
mintlify[bot] Sep 4, 2026
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
2 changes: 1 addition & 1 deletion agent-context/context/skills/mintlify/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Use `<Columns>` to arrange cards (or other content) in a grid. `cols` accepts 1-

## CLI commands

Install with `npm i -g mint`. Key commands: `mint dev` (local preview), `mint validate`, `mint broken-links`, `mint a11y`, `mint score`, `mint automations`, `mint new`, `mint signup`, `mint index` (install the Mintlify Index MCP server in supported coding agents). Read `reference/cli.md` for full flags and subcommands.
Install with `npm i -g mint`. Key commands: `mint dev` (local preview), `mint validate`, `mint broken-links`, `mint a11y`, `mint test` (generate tests from code samples), `mint score`, `mint automations`, `mint new`, `mint signup`, `mint index` (install the Mintlify Index MCP server in supported coding agents). Read `reference/cli.md` for full flags and subcommands.

## Writing standards

Expand Down
2 changes: 1 addition & 1 deletion agent-context/context/skills/mintlify/reference/api-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For OpenAPI 3.1 specs, describe a file upload field as a string schema with a bi

- `x-hidden`: Creates page but hides from navigation.
- `x-excluded`: Completely excludes endpoint from docs.
- `x-codeSamples`: Custom code examples per endpoint.
- `x-codeSamples`: Custom code examples per endpoint. Write these by hand. If you generate SDKs with Speakeasy, you can instead point the `openapi` field in `docs.json` at the Speakeasy combined spec URL (the `*-with-code-samples` API Registry entry) to pull autogenerated samples.
- `x-mint.playground.expand`: Set to `false` on an operation to collapse nested object fields in the playground by default. Request sections (Authorization, Headers, Query, Path, Body) and the top-level body object stay expanded. Defaults to expanded when unset.

```yaml
Expand Down
1 change: 1 addition & 0 deletions agent-context/context/skills/mintlify/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Available on all commands.
- `mint a11y` — Accessibility checks (alt text, color contrast). `--skip-contrast` or `--skip-alt-text` to narrow scope.
- `mint score [url]` — Score a docs site's AI/agent readiness. Checks llms.txt, MCP discoverability, robots.txt, sitemap, structured data, response latency, and more. Requires `mint login`. Defaults to your configured subdomain. `--format` accepts `table` (default), `plain`, or `json`.
- `mint format` — Format every `.mdx` file in the current directory and its subdirectories in place. Respects `.gitignore` and Mintlify ignore rules. Commit or stash changes first so you can review the rewrite.
- `mint test` — Scan content for code blocks and generate unit tests that validate them. Interactive; only pages in the `docs.json` navigation appear for selection. Writes generated test projects to `tests/mint-test/<run-id>/` (one directory per agent and page) and run reports to `.mintlify/test/` (including `runs/<run-id>.json`). Add both paths to `.gitignore` to avoid committing test artifacts.

## Authentication

Expand Down