---
name: qaf-developer-docs
description: "Read the Qaf developer docs instead of answering from memory. Search and read classical Islamic books from an AI app or your own code, with the Qaf MCP server and API. Use when a task involves Qaf developer docs: how it works, how to set it up or configure it, or its API."
---

# Qaf developer docs

Search and read classical Islamic books from an AI app or your own code, with the Qaf MCP server and API.

This skill points you at the Qaf developer docs, at https://developers.qaf.ai/. When a task involves Qaf developer docs, read the relevant page before relying on what you remember: the docs are the source of truth, and they change.

## Reading the docs

- Any page as Markdown: add `.md` to its URL (the home page is https://developers.qaf.ai/index.md). Every page link below already points at the Markdown.
- [llms.txt](https://developers.qaf.ai/llms.txt): every page with a one-line summary.
- [llms-full.txt](https://developers.qaf.ai/llms-full.txt): every page in one file, for when you need all of it.
- [Changelog](https://developers.qaf.ai/changelog.md): release notes, newest first.

## API reference

- [Qaf API](https://developers.qaf.ai/reference), with a page per operation (add `.md` for its Markdown).

## Pages

- [Qaf developer docs](https://developers.qaf.ai/index.md): Search and read classical Islamic books from an AI app or your own code, with the Qaf MCP server and the Qaf API.
- [The Qaf library](https://developers.qaf.ai/library.md): Books, authors, passages, printed pages, IDs and genres in the Qaf library, as the MCP server and the API return them.

### MCP server

- [MCP server](https://developers.qaf.ai/mcp.md): Connect Claude, ChatGPT, Cursor and other AI apps to the Qaf library with the Qaf MCP server. Sign in with your Qaf account; no API key.
- [Connect an AI app](https://developers.qaf.ai/mcp/connect.md): Add the Qaf MCP server to Claude, ChatGPT, Claude Code, Codex, Cursor, VS Code or another MCP app, then sign in with your Qaf account.
- [Tools](https://developers.qaf.ai/mcp/tools.md): The three Qaf MCP tools, search, fetch and lookup_catalog, with every input, limit, default and output field, and the errors they return.
- [Sign-in and connected apps](https://developers.qaf.ai/mcp/authentication.md): How an AI app signs in to the Qaf MCP server with your Qaf account, how to disconnect it, and the OAuth details for client developers.

### API

- [API overview](https://developers.qaf.ai/api.md): The Qaf API v1 at api.qaf.ai/v1. Endpoints, request and response format, authentication, the OpenAPI document, request IDs and the versioning policy.
- [Quickstart](https://developers.qaf.ai/api/quickstart.md): Create a Qaf API key, store it, search the library and read the passages around a result, with cURL, TypeScript and Python examples.
- [Authentication](https://developers.qaf.ai/api/authentication.md): Create, use, protect and revoke Qaf API keys. Keys belong to your Qaf account and are created in qaf.ai Settings › API keys.
- [Errors](https://developers.qaf.ai/api/errors.md): The Qaf API's JSON error format, every status and code it returns, which errors to retry, and how request IDs help support find a request.
- [Rate limits](https://developers.qaf.ai/api/rate-limits.md): The Qaf API allows 60 requests a minute and 1,000 searches a day per account. The rate-limit headers, the 429 response, and how to back off.

### Guides

- [Search and read passages](https://developers.qaf.ai/guides/search.md): Write queries that find the right passages, filter by author, book, genre or death year, get more results, and read the text around a passage.
- [Cite passages](https://developers.qaf.ai/guides/citations.md): Show where each passage comes from, with its book, author, printed page and link, and quote Qur’an verses and hadiths exactly as returned.

### Resources

- [Docs for AI agents](https://developers.qaf.ai/agents.md): Read these docs as Markdown, through llms.txt, the OpenAPI document and the discovery files, from a coding agent or an AI assistant.