hana-developer-cli-tool-example general-documentation.instructions.md

Documentation-writing guidance for standard VitePress pages outside the command-reference section, covering structure, style, links, and preserving useful existing content.

In plain words
What is it for?
Use it when creating or updating getting-started, feature, API, development, reference, troubleshooting, or other general documentation pages.
Why use it?
It helps new documentation match the repository and prevents useful explanations from being removed during edits.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/sap-samples/hana-developer-cli-tool-example/general-documentation
Clone the repo
git clone --depth 1 https://github.com/SAP-samples/hana-developer-cli-tool-example

Made for: GitHub Copilot.

Per session 1,105 This file is loaded in full into every session.
When invoked 1,105 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.01105 $0.01105
Opus 5 $0.00553 $0.00553
Sonnet 5 $0.00221 $0.00221
Haiku 4.5 $0.00111 $0.00111

Measured 2d ago against content hash 706fdebfabc7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

hana-developer-cli-tool-example general-documentation.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 2d 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/instructions/general-documentation.instructions.md · 126 lines

How it starts

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

General Documentation Guidelines (Non-Command Docs)

Use this guide for standard documentation pages in docs/ outside docs/02-commands/.

Scope

This file applies to:

  • docs/01-getting-started/**/*.md
  • docs/03-features/**/*.md
  • docs/04-api-reference/**/*.md
  • docs/05-development/**/*.md
  • docs/99-reference/**/*.md
  • docs/troubleshooting/**/*.md
  • root docs pages like docs/index.md

This file does not apply to command reference pages in docs/02-commands/** (handled by command-documentation.instructions.md).

Preservation Rule (Do Not Remove Existing Helpful Context)

When updating existing pages, preserve useful educational and explanatory content unless it is clearly outdated, incorrect, duplicated, or the user explicitly asks to remove it.

Practical rules:

  • Update the target section without stripping unrelated narrative value.
  • Keep existing examples if still valid; improve rather than delete.
  • Maintain page-specific details (platform notes, edge cases, caveats) unless they are wrong.

Standard Page Structure

Use this baseline structure unless a page type needs a variation:

  1. # Title (single H1)
  2. Short intro paragraph (what this page helps with)
  3. Main sections with ## headings
  4. Concrete examples (bash, json, text, etc.)
  5. Optional reference tables for options, comparisons, or troubleshooting mappings
  6. ## See Also with related internal links

Typical Section Patterns

Use patterns already common in this repo:

  • Guide pages: Prerequisites → Steps/Methods → Validation → Troubleshooting → Next Steps
  • Feature pages: Overview → Use Cases → Configuration → Examples → Related Topics
  • API pages: Overview → Endpoints/Contracts → Request/Response examples → Error handling → Security notes
  • Troubleshooting pages: Problem/Error → Likely causes → Step-by-step fixes → Verification
  • Index/landing pages: Section overview + concise link lists to child pages

Writing Style

  • Be concise, actionable, and user-focused.
  • Prefer direct instructions over vague statements.
  • Use consistent terminology: "HANA CLI", "hana-cli", "SAP HANA", "MCP".
  • Avoid hype language; prioritize technical clarity.
  • Keep headings descriptive and scannable.

Read the full file on GitHub · 126 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. 2d ago First seen · 126 lines · 1,105 tokens per session scan A 706fdebfabc7

Subscribe to this mod's changes

hana-developer-cli-tool-example general-documentation.instructions.md is an instructions file published in the GitHub repository SAP-samples/hana-developer-cli-tool-example (109 stars, last pushed 7d ago), licensed Apache-2.0. It adds 1,105 tokens to every session, about $0.0055 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-30.