README
¶
GoForj Atlas
Agent-native project navigation and MCP tooling for GoForj.
Atlas helps local coding agents understand GoForj projects without guessing framework conventions. It installs concise project guidance, synchronizes skills or agent-native instruction files, configures one project-level MCP server, and exposes safe read-only project inspection tools.
Users should normally reach Atlas through the GoForj CLI:
forj atlas:install
forj atlas:mcp
This repository contains the reusable Atlas library. The GoForj CLI exposes it
through forj atlas:* commands so projects do not need to install a separate
binary.
What Atlas Provides
Atlas gives local agents a framework-aware view of a GoForj project:
- concise project guidance for Codex, Claude Code, and GitHub Copilot
- synchronized skills and agent-native instruction files
- one project-level MCP server
- app-aware project layout, route, schedule, and command inspection
- version-aware docs search and section reads
- safe database, log, browser, URL, and metrics inspection hooks
Safety Model
Atlas starts read-only. It does not expose arbitrary shell execution or write-capable MCP tools in the MVP.
When source scaffolding is needed, agents should use normal GoForj commands:
forj make:controller users
forj marketplace make:job sync-catalog
Development
GOCACHE=/tmp/gocache GOMODCACHE=/tmp/gomodcache go test ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agents contains adapters for writing Atlas integration files for local coding agents.
|
Package agents contains adapters for writing Atlas integration files for local coding agents. |
|
Package config reads and writes project-owned Atlas installation state.
|
Package config reads and writes project-owned Atlas installation state. |
|
Package diagnostics defines read-only runtime inspection contracts for Atlas.
|
Package diagnostics defines read-only runtime inspection contracts for Atlas. |
|
Package docs provides version-aware Markdown retrieval for Atlas tools.
|
Package docs provides version-aware Markdown retrieval for Atlas tools. |
|
Package files contains filesystem helpers that preserve user-authored agent files.
|
Package files contains filesystem helpers that preserve user-authored agent files. |
|
Package guidelines composes concise generated guidance for local coding agents.
|
Package guidelines composes concise generated guidance for local coding agents. |
|
Package install coordinates Atlas agent installation and update workflows.
|
Package install coordinates Atlas agent installation and update workflows. |
|
Package mcp exposes Atlas read-only project tools through the MCP protocol.
|
Package mcp exposes Atlas read-only project tools through the MCP protocol. |
|
Package project models the GoForj project facts Atlas needs to guide agents.
|
Package project models the GoForj project facts Atlas needs to guide agents. |
|
Package skills synchronizes built-in and project-owned Atlas skills.
|
Package skills synchronizes built-in and project-owned Atlas skills. |