mcp-server-ngzorro: Instructions file for GitHub Copilot

.github/copilot-instructions.md

mcp-server-ngzorro copilot-instructions.md is an instructions file for GitHub Copilot from velrys/mcp-server-ngzorro. It costs 1,034 tokens per session, scanned A, original, MIT.

A local MCP server that provides documentation for NG-ZORRO, a component library for building Angular web interfaces. It retrieves the documentation through GitHub.

In plain words
What is it for?
Use it to look up NG-ZORRO components, APIs, and usage guidance during Angular development.
Why use it?
It helps an assistant consult NG-ZORRO documentation while working on an Angular project, instead of relying only on remembered information.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is velrys/mcp-server-ngzorro's own configuration. It tells GitHub Copilot how to work on mcp-server-ngzorro 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-server-ngzorro configures →

Reuse

Borrowing it

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

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-server-ngzorro copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/velrys/mcp-server-ngzorro/copilot-instructions.svg)](https://agentmods.dev/instructions/velrys/mcp-server-ngzorro/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/velrys/mcp-server-ngzorro/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/velrys/mcp-server-ngzorro/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,034 This file is loaded in full into every session.
When invoked 1,034 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.01034 $0.01034
Opus 5 $0.00517 $0.00517
Sonnet 5 $0.00207 $0.00207
Haiku 4.5 $0.00103 $0.00103

Measured 7d ago against content hash 7cb0a573d033, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

mcp-server-ngzorro 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 7d 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 · 113 lines

How it starts

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

MCP Server NG-ZORRO - AI Coding Assistant Guide

Este é um servidor MCP (Model Context Protocol) que fornece acesso à documentação do NG-ZORRO (Ant Design for Angular) via GitHub API.

🏗️ Arquitetura

Core Components

  • server.ts: Single server instance com 6 tools MCP registradas usando server.tool() API
  • lib/github.ts: Wrapper da Octokit para busca/carregamento de docs
  • lib/cache.ts: Cache LRU para docs (30min) e listings (10min) usando LRUCache named import
  • lib/topic.ts: Extrator heurístico de componentes NG-ZORRO
  • lib/octokit.ts: Configuração centralizada da GitHub API

Data Flow

  1. Request → Topic extraction (regex patterns)
  2. GitHub API fetch via Octokit → Cache layer
  3. Markdown processing → MCP response

🛠️ Development Workflows

# Development (hot reload with tsx)
npm run dev

# Build & run production
npm run build && npm start

# Test tools locally via stdio
echo '{"method":"tools/list"}' | npm run dev

🔧 Environment Variables

Todas opcionais com defaults sensatos:

  • GITHUB_TOKEN - Increase rate limits (recommended)
  • NGZ_OWNER=NG-ZORRO / NGZ_REPO=ng-zorro-antd / NGZ_BRANCH=master
  • NGZ_DOCS_PATH=docs - Root docs directory

📋 MCP Tools Patterns

Tool Registration API

  • Pattern: server.tool(name, description, schema, handler)
  • Schema: { param: z.string().optional() } para ZodRawShape
  • Return: { content: [{ type: "text" as const, text: string }], isError?: boolean }
  • Async: Todas as funções handler são async

Key Tools

  • extract_ngzorro_topic: Heuristic component detection from natural language
  • query_ngzorro_document: Smart path resolution with fallback search
  • ngz_*: Direct GitHub API operations (list, get, search)

Path Resolution Logic in query_ngzorro_document:

  1. Direct path if starts with docs/
  2. Template substitution: docs/components/${topic}/index.en-US.md
  3. Fallback to GitHub code search
  4. Error if nothing found

Read the full file on GitHub · 113 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. 7d ago First seen · 113 lines · 1,034 tokens per session scan A 7cb0a573d033

Subscribe to this mod's changes

mcp-server-ngzorro copilot-instructions.md is an instructions file published in the GitHub repository velrys/mcp-server-ngzorro (0 stars, last pushed 11mo ago), licensed MIT. It adds 1,034 tokens to every session, about $0.0052 per session on Opus 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

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,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

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 · 6,785 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 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,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens