fastapi-docs-mcp: Instructions file for GitHub Copilot

.github/copilot-instructions.md

fastapi-docs-mcp copilot-instructions.md is an instructions file for GitHub Copilot from jaredthivener/fastapi-docs-mcp. It costs 1,314 tokens per session, scanned A, original, MIT.

A project guide for an MCP server that fetches and searches the official FastAPI documentation. MCP is a way for AI assistants to call tools, and this server exposes six documentation-related tools.

In plain words
What is it for?
Use it when changing the FastAPI documentation tools, sitemap-based page discovery, or HTML and code-block extraction.
Why use it?
It helps an agent understand the server's single-file design, how it discovers documentation pages, and how it extracts text and code from HTML without extra parsing libraries.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions AGENTS.md.

This is jaredthivener/fastapi-docs-mcp's own configuration. It tells GitHub Copilot how to work on fastapi-docs-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything fastapi-docs-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to jaredthivener/fastapi-docs-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/jaredthivener/fastapi-docs-mcp/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/jaredthivener/fastapi-docs-mcp

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for fastapi-docs-mcp copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions/github.svg)](https://agentmods.dev/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for fastapi-docs-mcp copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/jaredthivener/fastapi-docs-mcp/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,314 This file is loaded in full into every session.
When invoked 1,314 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01314 $0.01314
Opus 5.5 $0.00526 $0.00526
Sonnet 5.5 $0.00263 $0.00263
Haiku 4.5 $0.00131 $0.00131

Measured 1mo ago against content hash 102b1379e66d, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

fastapi-docs-mcp copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 99 lines

How it starts

The opening of the file, as written. The whole thing — 99 lines — stays where its author put it; the contents beside it link to each section on GitHub.

FastAPI Docs MCP Server — AI Agent Guide

Project Overview

FastAPI Docs MCP is a Model Context Protocol server providing real-time access to FastAPI documentation. It exposes 6 read-only tools: get_fastapi_docs, search_fastapi_docs, list_fastapi_pages, get_fastapi_example, compare_fastapi_approaches, and get_fastapi_best_practices — see AGENTS.md for the full tool contract (signatures, return shape, error semantics).

The implementation is a small package under src/fastapi_docs_mcp/, not a single file. Each module is one layer:

Module Responsibility
config.py Every magic value (URLs, allowlist, timeouts, limits) in one place
http.py The single network choke point: host allowlist (enforced post-redirect), size cap, timeout
cache.py TTL + LRU cache with single-flight de-duplication
sitemap.py Discovery — the sitemap is the only source of page-path truth, plus keyword aliases
markdown.py Preferred content path: raw GitHub markdown, include-directive resolution, MkDocs-syntax cleanup
html.py Fallback-only content path: regex text/code extraction from the rendered site
content.py Orchestrates markdown-then-HTML fallback; the one place that distinguishes a confirmed-absent page (None) from an unreachable one (ToolError)
app.py The shared FastMCP instance, tool annotations, lifespan (closes the HTTP client)
server.py Logging setup, imports tools to register it, run()
tools.py The 6 @mcp.tool functions — thin orchestration + response formatting

Key Architecture Patterns

Markdown-preferred, HTML-fallback content

content.py fetches FastAPI's raw markdown from GitHub first (token-efficient, preserves code fences) and only falls back to parsing the rendered HTML page if markdown is unavailable. This is the resilience guarantee: an upstream change to one source degrades gracefully instead of breaking the tool.

No HTML parsing library

html.py uses re.sub() regex passes rather than BeautifulSoup/lxml — it is the fallback path only (exercised when markdown fails), kept deliberately lean and covered by hypothesis property tests (tests/test_html.py).

Read the full file on GitHub · 99 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago Changed · +17 lines · +110 tokens per session 102b1379e66d
  2. 1mo ago First seen · 82 lines · 1,204 tokens per session scan A 9253fd9430cc

Subscribe to this mod's changes

fastapi-docs-mcp copilot-instructions.md is an instructions file published in the GitHub repository jaredthivener/fastapi-docs-mcp (4 stars, last pushed 2d ago), licensed MIT. It adds 1,314 tokens to every session, about $0.0053 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,581 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens