Skip to content
AGENTS

agents-core

AGENTS monorepo root — architecture, concepts, deployment guides

I don’t have the source files for the package yet. To generate an accurate, specific documentation page that includes exact function names, config fields, tool registrations, and real TypeScript code snippets from your repository, I need the package source (or the relevant files). Please provide one or more of the following:

  • package.json for agents-core (to list dependencies and entry points)
  • src/index.ts, src/main.ts, or the module entry file
  • Any tool registration files (e.g., src/tools/*.ts)
  • Abilities and agent definitions (e.g., src/abilities/, src/agents/)
  • config.toml, config.sample.toml, or any configuration files
  • README.md or other docs in the package
  • Vault/secrets usage examples or environment variable references (e.g., .env.example)
  • Any exported API surface (types, functions) you want documented

If you prefer, paste the content of these specific files directly into your reply:

  • src/index.ts (or the main exported module)
  • src/tools/index.ts (or a file that registers tools)
  • src/abilities/* (one or two representative ability files)
  • config/config.toml or config.sample.toml
  • README or top-level comments describing architecture

What I will produce once I have the files:

  • A single Markdown doc starting with ”# agents-core” and the required one-line blockquote
  • Sections: Overview, Architecture, Tools / API (table of tools and parameters), Configuration (config.toml fields, env vars, secrets vault), Code Examples (actual TypeScript snippets copied from your source), Dependencies (what it depends on and what depends on it)
  • If your source registers tools, I will create a table documenting each tool name, exported function, description, and parameters
  • Focused guidance for developers who need to modify or extend the package

If you want, you can also point me to a Git URL or a GitHub file paths and I can fetch the files (if public).