Skip to Content
PlatformUsing AI with Aetherfy
Raw

Using AI with Aetherfy

Why point your coding agent at the Aetherfy docs

Language models trained before a given release will guess at Aetherfy package names, identifiers and limits, and the guesses are confidently wrong in predictable ways. The Aetherfy documentation site publishes machine-readable artifacts precisely so an agent can read the current truth instead of recalling an old one. This page shows what those artifacts are and how to make your tools fetch them.

Machine-readable entry points published by Aetherfy

Every artifact below is served from the Aetherfy documentation site and is fetchable without authentication.

URLWhat it contains
https://docs.aetherfy.com/llms.txtThe route list, each with a one-line description
https://docs.aetherfy.com/llms-full.txtThe reference pages inlined in full
https://docs.aetherfy.com/docs-manifest.jsonEvery page’s metadata, heading outline and content hash
https://docs.aetherfy.com/raw/<route>.mdThe clean markdown source of any page, one file per route
https://docs.aetherfy.com/openapi.jsonThe Aetherfy vector REST surface as an OpenAPI 3.1 document
https://docs.aetherfy.com/aetherfy-yaml.schema.jsonA JSON Schema for aetherfy.yaml
https://docs.aetherfy.com/errors.jsonError code, meaning, and whether it is retryable

Two usage notes. First, llms.txt is the cheap index and llms-full.txt is the expensive complete text — start with the index unless the agent is about to write Aetherfy code, in which case fetch the full file. Second, the manifest lists each page’s rawUrl, so an agent that has read docs-manifest.json can resolve any page to its markdown without guessing the raw URL pattern.

The content hash in the Aetherfy manifest is the cheapest way to tell whether a cached copy of a page is stale: compare hashes rather than re-fetching bodies.

A rules snippet to give your agent Aetherfy context

Drop the following into .cursorrules, .github/copilot-instructions.md, or whichever rules file your assistant reads. It points the agent at the artifacts above and pins the three Aetherfy facts that are hallucinated most often.

# Aetherfy Before writing any Aetherfy code, fetch https://docs.aetherfy.com/llms-full.txt and follow it over prior knowledge. Reference artifacts: - https://docs.aetherfy.com/llms.txt route index - https://docs.aetherfy.com/llms-full.txt full reference text - https://docs.aetherfy.com/docs-manifest.json page metadata, outlines, content hashes - https://docs.aetherfy.com/openapi.json vector REST surface (OpenAPI 3.1) - https://docs.aetherfy.com/aetherfy-yaml.schema.json schema for aetherfy.yaml - https://docs.aetherfy.com/errors.json error codes and retryability Facts that are commonly got wrong — do not deviate from these: - The Python distribution is `aetherfy-vectors`; the import package is `aetherfy_vectors`. - The npm package is `aetherfy-vectors`, unscoped. It is not `@aetherfy/vectors`. - A point id must be an unsigned integer or a UUID string. No other id type is valid.

Adjust the heading syntax to whatever your tool expects; the content is what matters.

The Aetherfy MCP server — coming soon

An Aetherfy MCP server is planned. It is not yet available. There is no endpoint to configure today, and any MCP server URL you may have seen elsewhere claiming to serve Aetherfy documentation is not ours.

When it ships it will read exactly the artifacts listed above — the same manifest, raw markdown, OpenAPI document, aetherfy.yaml schema and error catalogue — so anything you build against those files now will carry over unchanged. The endpoint will be published on this page.

Until then, the fetch-the-URLs approach in the rules snippet above is the supported way to give an agent Aetherfy context.

Retrieval metadata on every Aetherfy documentation page

Every page in the Aetherfy documentation carries frontmatter designed for retrieval rather than for rendering:

FieldPurpose
slugStable identifier for the page, independent of its URL
kindreference, explanation or howto
surfaceWhich part of Aetherfy the page belongs to
summaryOne sentence describing the page; also the meta description
sourcesThe repository paths the content was derived from

Aetherfy reference pages are plain markdown — headings, tables and fenced code blocks, with no interactive components. A fetched Aetherfy page needs no HTML scraping and no JavaScript execution to be usable as context, and its heading structure chunks cleanly for embedding.

Last updated on