pymapdl: Instructions file for Codex

AGENTS.md

pymapdl AGENTS.md is an instructions file for Codex, OpenCode from ansys/pymapdl. It costs 2,004 tokens per session, scanned A, original, MIT.

Repository instructions for PyMAPDL, a Python client library that connects programs to Ansys MAPDL engineering software.

In plain words
What is it for?
They guide coding-agent work such as modifying the library, running tests, updating documentation, and applying formatting or pre-commit checks.
Why use it?
They explain the project layout, required tools, files that must not be edited, coding constraints, and commands for checking changes.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions CLAUDE.md; mentions AGENTS.md.

This is ansys/pymapdl's own configuration. It tells Codex and OpenCode how to work on pymapdl 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 pymapdl configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ansys/pymapdl. 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/ansys/pymapdl/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/ansys/pymapdl

Made for: Codex, OpenCode.

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 pymapdl AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ansys/pymapdl/agents-md/github.svg)](https://agentmods.dev/instructions/ansys/pymapdl/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/ansys/pymapdl/agents-md"><img src="https://agentmods.dev/badge/instructions/ansys/pymapdl/agents-md/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 pymapdl AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ansys/pymapdl/agents-md"><img src="https://agentmods.dev/badge/instructions/ansys/pymapdl/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,004 This file is loaded in full into every session.
When invoked 2,004 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.02004 $0.02004
Opus 5.5 $0.00802 $0.00802
Sonnet 5.5 $0.00401 $0.00401
Haiku 4.5 $0.00200 $0.00200

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

Security

Grade A, and why

pymapdl AGENTS.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 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.

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.

AGENTS.md · 227 lines

How it starts

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

AGENTS.md

Instructions for AI coding agents working in the PyMAPDL repository. This is the single source of truth; CLAUDE.md just points here.

PyMAPDL (ansys-mapdl-core) is the Python client library for Ansys MAPDL.

Repository layout

Path Content
src/ansys/mapdl/core/ Library source
src/ansys/mapdl/core/_commands/ Auto-generated. Never edit.
src/ansys/mapdl/core/mapdl_extended.py _MapdlCommandExtended: where MAPDL command behavior is overridden
src/ansys/mapdl/core/launcher/ Launching and connecting to MAPDL
tests/ Test suite; shared fixtures and helpers in tests/conftest.py
doc/source/ Sphinx documentation
doc/changelog.d/ Towncrier changelog fragments (generated by CI/CD; do not add)
examples/ Gallery examples
.github/agents/ Specialized agent definitions

Environment

Use uv for everything. Fall back to the repository .venv only if uv fails.

uv sync --all-extras          # install dependencies
uv run pytest                 # run tests
uv run pre-commit install     # install hooks (once)
uv run pre-commit run --all-files

Supported Python: 3.10 - 3.14.

Hard constraints

  • Never modify anything under src/ansys/mapdl/core/_commands/. To change the behavior of a MAPDL command, override it in _MapdlCommandExtended in src/ansys/mapdl/core/mapdl_extended.py.
  • Never break backward compatibility. Deprecate instead, with a warning and a removal version.
  • Never add files to doc/changelog.d/. Changelog fragments are generated automatically by CI/CD when the pull request is opened.
  • Never commit secrets, credentials, or license server details.
  • Pre-commit must pass before every commit. It is mandatory and runs black, isort, flake8, mypy, codespell, numpydoc-validation, bandit, license headers, and more.

Code style

  • PEP 8, enforced by black and isort (profile = "black").
  • Type hints on new public APIs. mypy runs on src/ through pre-commit.
  • No bare except: and no overly broad exception handling. Catch the specific exception, or the narrowest useful base class.
  • Group nested context managers:

Read the full file on GitHub · 227 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. 2mo ago First seen · 227 lines · 2,004 tokens per session scan A 505514d4431b

Subscribe to this mod's changes

pymapdl AGENTS.md is an instructions file published in the GitHub repository ansys/pymapdl (525 stars, last pushed today), licensed MIT. It adds 2,004 tokens to every session, about $0.0080 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-30.

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,461 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,750 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