mcp-sphinx-docs: Instructions file for GitHub Copilot

.github/copilot-instructions.md

mcp-sphinx-docs copilot-instructions.md is an instructions file for GitHub Copilot from zk-armor/mcp-sphinx-docs. It costs 340 tokens per session, scanned C, original, MIT.

Project instructions for building an MCP server that turns Sphinx documentation into Markdown formatted for AI assistants. Sphinx is a documentation system, and reStructuredText (RST) is one of its source formats.

In plain words
What is it for?
They cover parsing RST files, converting them to Markdown, splitting large documents, improving their structure for AI use, and resolving internal references.
Why use it?
They give an AI coding assistant the project context, design rules, and development guidance needed to change this documentation server consistently.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is zk-armor/mcp-sphinx-docs's own configuration. It tells GitHub Copilot how to work on mcp-sphinx-docs 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 mcp-sphinx-docs configures →

Reuse

Borrowing it

Nothing to install: this file belongs to zk-armor/mcp-sphinx-docs. 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/zk-armor/mcp-sphinx-docs/master/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/zk-armor/mcp-sphinx-docs

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 mcp-sphinx-docs copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/zk-armor/mcp-sphinx-docs/copilot-instructions/github.svg)](https://agentmods.dev/instructions/zk-armor/mcp-sphinx-docs/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/zk-armor/mcp-sphinx-docs/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/zk-armor/mcp-sphinx-docs/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 mcp-sphinx-docs copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/zk-armor/mcp-sphinx-docs/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/zk-armor/mcp-sphinx-docs/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 340 This file is loaded in full into every session.
When invoked 340 The same file — it is already loaded in full.
Security scan C 1 finding. 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.00340 $0.00340
Opus 5.5 $0.00136 $0.00136
Sonnet 5.5 $0.00068 $0.00068
Haiku 4.5 $0.00034 $0.00034

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

Security

Grade C, and why

mcp-sphinx-docs copilot-instructions.md scanned grade C with 1 finding 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 2mo 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.

Hidden instructionshighPrompt injection

Directives inside HTML comments, invisible characters or bidirectional overrides are read by the model and not by the person reviewing the file.

<!-- Use this file to provide workspace-specific custom instructions to Copilot. For more details, visit https://code.visualstudio.com/docs/copilot/copilot-customization#_use-a-githubcopilotinstructionsmd-file -->
.github/copilot-instructions.md · 35 lines

What it actually says

Copilot Instructions for Sphinx to LLM Markdown MCP Server

You can find more info and examples at https://modelcontextprotocol.io/llms-full.txt

Project Context

This is a Model Context Protocol (MCP) server that converts Sphinx documentation to LLM-optimized Markdown. The server provides tools to:

  1. Parse Sphinx RST files - Extract content from reStructuredText files
  2. Convert to Markdown - Transform RST syntax to clean Markdown
  3. Optimize for LLMs - Apply formatting and chunking for better LLM consumption
  4. Handle References - Process internal links and cross-references

Architecture Guidelines

Key Components

  • RST Parser: Parse reStructuredText syntax and directives
  • Markdown Writer: Generate clean, consistent Markdown output
  • LLM Optimizer: Apply transformations for better LLM consumption
  • Chunker: Split large documents intelligently
  • Reference Resolver: Handle internal links and cross-references

Code Style

  • Use descriptive function and variable names
  • Add comprehensive JSDoc comments
  • Implement robust error handling
  • Use Zod for input validation
  • Follow MCP server conventions
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. 2mo ago First seen · 35 lines · 340 tokens per session scan C 275d6d271113

Subscribe to this mod's changes

mcp-sphinx-docs copilot-instructions.md is an instructions file published in the GitHub repository zk-armor/mcp-sphinx-docs (2 stars, last pushed 1y ago), licensed MIT. It adds 340 tokens to every session, about $0.0014 per session on Opus 5.5. A static security scan graded it C with 1 finding (hidden instructions). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

mcp-sphinx-docs copilot-instructions.md compared with instructions from other repositories

mcp-sphinx-docs copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
mcp-sphinx-docs copilot-instructions.mdzk-armor/mcp-sphinx-docsInstructions file21y agoMITC340GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode