GitCode-API AGENTS.md

A project instruction file for a Python software library that talks to the GitCode REST API. REST APIs are web interfaces that applications use to request and change data; the library includes synchronous and asynchronous clients, helpers for repositories and pull requests, models, a command-line tool, and optional agent adapters.

In plain words
What is it for?
Use it when developing, testing, documenting, or adding API and agent integrations to GitCode-API.
Why use it?
It gives coding agents the project structure, tools, conventions, and commands needed to change the library consistently.

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/trenza1ore/gitcode-api/agents-md
Clone the repo
git clone --depth 1 https://github.com/Trenza1ore/GitCode-API

Made for: Codex, OpenCode.

Per session 3,160 This file is loaded in full into every session.
When invoked 3,160 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.03160 $0.03160
Opus 5 $0.01580 $0.01580
Sonnet 5 $0.00632 $0.00632
Haiku 4.5 $0.00316 $0.00316

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

Security

Grade A, and why

GitCode-API 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 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.

AGENTS.md · 181 lines

How it starts

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

AGENTS.md

Guidance for AI agents working in this repository.

Project Overview

gitcode-api is a community-maintained Python SDK for the GitCode REST API. It exposes synchronous and asynchronous httpx clients, resource-oriented helpers such as client.repos and client.pulls, lightweight response models, a small CLI, examples, and Sphinx documentation. Optional LLM / agent helpers live under gitcode_api.llm (OpenAI Chat Completions tool shape, MCP via FastMCP) with lazy imports so the core install stays light.

Primary source paths:

  • gitcode_api/: package source.
  • gitcode_api/_client.py: top-level GitCode and AsyncGitCode clients.
  • gitcode_api/_base_client.py: shared transport, auth, URL building, payload cleanup, response parsing, and context-manager behavior.
  • gitcode_api/_base_resource.py: shared resource introspection (methods, method_signature).
  • gitcode_api/resources/: sync and async REST resource groups.
  • gitcode_api/_models.py: dictionary-backed response models and typed parameter payloads.
  • gitcode_api/llm/: optional adapters — GitCodeOpenAITool, GitCodeMCP, create_openjiuwen_gitcode_api_tool (openJiuwen LocalFunction, requires openjiuwen on Python 3.11+), create_mcp_* / register_mcp_* / create_mcp_server; shared logic in gitcode_api/llm/_tool.py (GitCodeLLMTool). Public names load lazily through gitcode_api.llm.__getattr__.
  • gitcode_api/cli.py: installed CLI entry point, exposed as gitcode-api.
  • tests/: unit tests and docs-backed endpoint/response checks.
  • docs/: Sphinx documentation.
  • examples/: runnable examples that read configuration from examples/.env.

Ignore generated or build output as source of truth, especially build/, dist/, docs/_build/, docs/_downloads/, and docs/sdk/generated/.

Tooling And Commands

Use uv from the repository root.

  • Install/sync development dependencies: uv sync --all-groups.
  • Run tests: uv run pytest or make test.
  • Run a focused test: uv run pytest tests/test_client.py -k context_manager.
  • Format and fix imports: make format.
  • Type-check the package: make lint (mypy -p gitcode_api).
  • Check docstrings: make docstring.
  • Build docs: make docs-dev (this also runs reST table alignment fixing).
  • Build a standalone CLI binary (PyInstaller one-file): make binary (uses dependency group binary; output under dist/).

Read the full file on GitHub · 181 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 · 181 lines · 3,160 tokens per session scan A 98c4d9f58143

Subscribe to this mod's changes

GitCode-API AGENTS.md is an instructions file published in the GitHub repository Trenza1ore/GitCode-API (7 stars, last pushed 1mo ago), licensed MIT. It adds 3,160 tokens to every session, about $0.0158 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.