API_SPECIFICATION

A technical contract for the agents module, describing its shared interfaces, provider clients, response handling, agent pools, evaluation, and conversation history.

In plain words
What is it for?
Use it when building or reviewing agent clients, choosing API or command-line integrations, handling responses, or checking compatibility with the module.
Why use it?
It gives developers one agreed description of how agent integrations should work, making implementations easier to connect and maintain.

Agent

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 agents/docxology/codomyrmex/api_specification
Clone the repo
git clone --depth 1 https://github.com/docxology/codomyrmex
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,335 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.01335
Opus 5 $0.00000 $0.00668
Sonnet 5 $0.00000 $0.00267
Haiku 4.5 $0.00000 $0.00134

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

Security

Grade A, and why

API_SPECIFICATION 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.

docs/modules/agents/API_SPECIFICATION.md · 140 lines

How it starts

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

Agents Module API Specification

Version: v0.2.0 | Status: Stable | Last Updated: March 2026

1. Overview

The agents module is the core framework for AI agent integration in Codomyrmex. It provides abstract interfaces, concrete client implementations for 12 providers, response parsing utilities, multi-agent pooling, evaluation, and conversation history.

2. Core Components

2.1 Base Classes

  • AgentInterface: The protocol that all agents must implement
  • BaseAgent: Common functionality (execute, validate, test_connection)
  • APIAgentBase: Base for HTTP API-based agents (error handling, token extraction, client init)
  • CLIAgentBase: Base for CLI wrapper agents (subprocess execution, streaming, health checks)

2.2 Provider Clients

API-based (extend APIAgentBase)
Client Module Provider Default Model Env Var
ClaudeClient claude/ Anthropic claude-3-opus-20240229 ANTHROPIC_API_KEY
CodexClient codex/ OpenAI code-davinci-002 OPENAI_API_KEY
O1Client o1/ OpenAI o1 OPENAI_API_KEY
DeepSeekClient deepseek/ DeepSeek deepseek-coder DEEPSEEK_API_KEY
QwenClient qwen/ Alibaba qwen-coder-plus DASHSCOPE_API_KEY
CLI-based (extend CLIAgentBase)
Client Module Binary Features
JulesClient jules/ jules Command-based execution
OpenCodeClient opencode/ opencode Open-source CLI
GeminiClient gemini/ gemini OAuth/API key, slash commands, @ files
MistralVibeClient mistral_vibe/ vibe Mistral AI models
EveryCodeClient every_code/ code Multi-agent orchestration, browser
OpenClawClient openclaw/ openclaw OpenClaw CLI agent
Local
Provider Module Access Features
Ollama llm/ollama/ HTTP to localhost:11434 Local model management, execution

Read the full file on GitHub · 140 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 · 140 lines · 0 tokens per session scan A 839aa6f54def

Subscribe to this mod's changes

API_SPECIFICATION is an agent published in the GitHub repository docxology/codomyrmex (11 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,335 tokens. 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.