Scalar API Reference skill for agents

Install

Works in

• Koda
• Coddy

npx skillfoxx add skills/scalar-api-reference-skill

What it does

The `scalar-api-reference` skill lives in the `.agents/skills` folder of the Scalar repository, an open API platform. It teaches an agent to embed Scalar's interactive documentation into an existing app from an OpenAPI description. The agent looks at the framework, package versions, routes and the address where the app already serves its API description, and picks the matching integration. The skill's table covers HTML and JavaScript, Vue, React, Next.js, Nuxt, Express, Fastify, Hono, NestJS, FastAPI and ASP.NET Core, with a package and entry point for each. The agent loads the API description through `url`, `content` or `sources`. The last option shows several APIs, each with a title, a `slug` and a default choice. The skill checks that `url` points to a browser-reachable address serving JSON or YAML rather than a file on disk or the documentation page. A separate section on authentication distinguishes access to the documentation page, access to the description and authentication of requests to the API itself: configuring the request client protects neither the page nor the description. The look is set with `theme`, `layout`, `showSidebar`, `darkMode` and theme variables rather than by editing internal selectors. When Swagger UI or Redoc documentation has to be replaced, the agent keeps the description address and generator, changes only the rendering on the intended route and carries over only the needed settings. At the end the skill requires checking the route and the description endpoint separately, confirming that operations and search appear, and reporting what was verified and what was not.

Who it is for. For backend and full-stack developers who already have an OpenAPI description and want a Scalar API reference page in place of Swagger UI or Redoc.

Example request

Replace Swagger UI in my FastAPI app with Scalar using the same OpenAPI description, make the theme dark and keep the route as it is

Limitations

• The skill attaches rendering and does not create an API description: without a ready OpenAPI description reachable from the browser, there is nothing to show.
• The integration table holds minimal entry points. The agent must check parameter names against the installed package version: the Python and .NET wrappers differ from JavaScript.
• The `persistAuth` option keeps credentials in the browser's local storage, so the skill enables it only on request. Production secrets do not go into public configuration.
• The `proxyUrl` option passes requests and credentials through a proxy, and the skill forbids quietly adding a public proxy to an existing app.
• When loaded from a CDN, the page may fetch a renderer of a different version than the wrapper package, and the version is then pinned with the `bundle` or `cdn` option described in the integration guide.
• MIT license.

How to disable. Delete the `scalar-api-reference` folder from your agent's skills directory. Scalar packages already installed and the reference route stay in the project; remove them by hand together with the `@scalar/api-reference` dependency or the integration package.

README in short

The Scalar description presents a platform of an API reference, a request client, packages and integrations. The quickstart has the skill install command, a ready prompt for an agent, a plain HTML example and a list of supported frameworks and environments. A table of Scalar products with documentation links follows. The repository holds AGENTS.md files for packages and several skills, of which the quickstart names one.