openapi AGENTS.md

A checklist for maintaining the Longbridge OpenAPI software library after code or protocol changes. It covers formatting, native Node.js builds, generated Rust files, and Python type information.

In plain words
What is it for?
Use it after changing Rust, the Node.js SDK, the protocol definitions, or the Python SDK, and before committing those changes.
Why use it?
Some files are generated and some language bindings are maintained separately. Following these steps helps prevent stale files, failed builds, and mismatched APIs.

Instructions file for CodexOpenCode

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/longbridge/openapi/agents-md
Clone the repo
git clone --depth 1 https://github.com/longbridge/openapi

Made for: Codex, OpenCode.

Per session 611 This file is loaded in full into every session.
When invoked 611 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.00611 $0.00611
Opus 5 $0.00305 $0.00305
Sonnet 5 $0.00122 $0.00122
Haiku 4.5 $0.00061 $0.00061

Measured yesterday against content hash edc42e2b2e8a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openapi 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 yesterday.

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.

Origin

Copies of this mod

2 near-identical copies found in the catalogue:

AGENTS.md · 70 lines

How it starts

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

Agent Guidelines

After modifying Rust code

Run the following commands from the workspace root:

cargo clippy --all --all-features
cargo +nightly fmt --all

Note: cargo +nightly fmt may reflow doc comments (e.g. /// @param … lines). Do not revert those changes — they are intentional formatting output and should be committed as-is.

After modifying the Node.js SDK (nodejs/)

Build the native .node binary from the nodejs/ directory:

npm run build:debug

nodejs/index.d.ts and nodejs/index.js are auto-generated by npm run build:debug — never edit them by hand.

After updating the proto submodule (rust/crates/proto/openapi-protobufs/)

Run the following command from the workspace root to regenerate the Rust proto source files (e.g. rust/crates/proto/src/longbridge.control.v1.rs, rust/crates/proto/src/longbridge.quote.v1.rs, rust/crates/proto/src/longbridge.trade.v1.rs):

cargo make protoc

The generated *.rs files under rust/crates/proto/src/ are auto-generated — never edit them by hand.

After modifying the Python SDK API (python/)

python/pysrc/longbridge/openapi.pyi is a manually maintained type-stub file that provides type hints and docstrings for the native Rust/PyO3 extension module. IDEs and type checkers (mypy/pyright) rely on it for autocompletion and static analysis.

When you add, remove, or change any #[pyclass]/#[pymethods] definitions in python/src/, you must update openapi.pyi accordingly — keeping signatures, type annotations, and docstrings in sync with the Rust implementation.

After modifying the C SDK (c/)

c/csrc/include/longbridge.h is auto-generated by cbindgen during the build — never edit it by hand. Rebuild the C crate to update it:

cargo build -p longbridge-c

After any change

Update CHANGELOG.md in the workspace root to document notable changes. The format follows Keep a Changelog. Add an entry under the [Unreleased] section in the appropriate subsection (Added, Changed, Fixed, Breaking changes, etc.). If the [Unreleased] section does not yet exist, create it at the top of the changelog (above the latest versioned block).

Read the full file on GitHub · 70 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. yesterday First seen · 70 lines · 611 tokens per session scan A edc42e2b2e8a

Subscribe to this mod's changes

openapi AGENTS.md is an instructions file published in the GitHub repository longbridge/openapi (450 stars, last pushed 4d ago), licensed Apache-2.0. It adds 611 tokens to every session, about $0.0031 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.