atlan-python: Instructions file for Claude Code

CLAUDE.md

atlan-python CLAUDE.md is an instructions file for Claude Code from atlanhq/atlan-python. It costs 346 tokens per session, scanned A, original, Apache-2.0.

Security and review instructions for Atlan's Python software development kit, which connects Python programs to the Atlan service. They define rules for handling API keys, encrypted connections, proxy settings, and user-provided service addresses.

In plain words
What is it for?
Use it when changing or reviewing the Atlan Python SDK, especially its connection setup, authentication, logging, network security, or URL validation.
Why use it?
It helps prevent secret tokens from appearing in logs, unsafe encrypted connections, leaked proxy credentials, and untrusted service addresses from entering the client.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

This is atlanhq/atlan-python's own configuration. It tells Claude Code how to work on atlan-python 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 atlan-python configures →

Reuse

Borrowing it

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

Made for: Claude Code.

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 atlan-python CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/atlanhq/atlan-python/claude-md/github.svg)](https://agentmods.dev/instructions/atlanhq/atlan-python/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/atlanhq/atlan-python/claude-md"><img src="https://agentmods.dev/badge/instructions/atlanhq/atlan-python/claude-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 atlan-python CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/atlanhq/atlan-python/claude-md"><img src="https://agentmods.dev/badge/instructions/atlanhq/atlan-python/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 346 This file is loaded in full into every session.
When invoked 346 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.00346 $0.00346
Opus 5.5 $0.00138 $0.00138
Sonnet 5.5 $0.00069 $0.00069
Haiku 4.5 $0.00035 $0.00035

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

Security

Grade A, and why

atlan-python CLAUDE.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.

CLAUDE.md · 30 lines

What it actually says

Security

Follow these security guidelines for every change to the pyatlan SDK.

Contact

  • Security Team: #bu-security-and-it on Slack

Quickstart for Agents

pyatlan is Atlan's Python SDK. It wraps the Atlan REST API using httpx, handles API key auth, and provides typed models for all Atlan entities. Review every change for:

  • API key logging — the api_key (and impersonation tokens from ImpersonationClient) must never appear in log output or error messages; log only the base_url and response status codes.
  • verify=False in httpx transport — TLS certificate verification must not be disabled; trust_env=True is correct for proxy support.
  • Proxy credential leakage — if proxy credentials are configured via environment variables (HTTPS_PROXY), they must not be echoed in log output.
  • User-supplied URL validation — base_url must be validated as HTTPS before constructing the client.

Security Invariants

  • [MUST] api_key and impersonation tokens must never appear in log output.
  • [MUST] TLS certificate verification must not be disabled (verify=False is forbidden).
  • [MUST] base_url must be validated as HTTPS.

Review Checklist

  • api_key and impersonation tokens absent from all log output and error messages
  • verify=False not used in any httpx transport or session
  • base_url validated as HTTPS before client construction
  • All direct dependencies in pyproject.toml pinned exactly
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 First seen · 30 lines · 346 tokens per session scan A cf593fc1eb69

Subscribe to this mod's changes

atlan-python CLAUDE.md is an instructions file published in the GitHub repository atlanhq/atlan-python (21 stars, last pushed yesterday), licensed Apache-2.0. It adds 346 tokens to every session, about $0.0014 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,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens