convez.ai
MCP ServerBusca & PesquisaIntermediário
e-kosten

PF2e Atlas

e-kosten/pf2e-atlas

Busca semântica offline e workbench editorial para Pathfinder 2E

Ver no GitHub
InicialPluginScore · de 0 a 100

MCP server e CLI para busca e referência offline de conteúdo Pathfinder 2ª Edição em dados locais do Foundry. Oferece busca semântica, resolução de nomes, filtros estruturados e contexto de grafo para jogadores, mestres e agentes de IA.

Instalação

$npx convez-ai e-kosten/pf2e-atlas

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
0
Forks
0
Acompanhando
0
Saúde
57%
Último commit
há 2 dias
Versão
—
Issues abertas
15
Contribuidores
3

Casos de uso

  • Consultar rapidamente regras e referências de PF2E durante sessões
  • Resolver nomes de magias, itens e ações com busca inteligente
  • Agentes locais explorarem conteúdo PF2E de forma estruturada

Veredito

Ferramenta especializada e bem-arquitetada para o ecossistema PF2E. A abordagem offline com busca semântica local é prática para GMs e jogadores, e a integração MCP/agent skill abre possibilidades para automação e assistentes. Implementação em Rust garante performance.

README

A tradução para o português deste README ainda está na fila.

PF2e Atlas

PF2e Atlas gives players, GMs, tool builders, and local coding agents a fast way to search and reference Pathfinder Second Edition content locally. It supports record lookup, ranked search, structured filters, name resolution, similar-record retrieval, and graph context.

The atlas CLI indexes PF2E data from the Foundry PF2E repository and exposes tools for people and agents.

What You Can Do

With atlas, you can:

  • search PF2E records by text, kind, and structured filters
  • resolve names (including by pre-remaster aliases)
  • find records similar to a known seed record
  • inspect nearby references around a known record
  • install a PF2e Atlas skill to educate local agents about the CLI so they can find PF2E content

Quick Start

Install the latest release:

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/e-kosten/pf2e-atlas/releases/latest/download/atlas-installer.sh | sh

On Windows, use PowerShell:

irm https://github.com/e-kosten/pf2e-atlas/releases/latest/download/atlas-installer.ps1 | iex

Run the standard first-time setup:

atlas setup

atlas setup fetches or updates the PF2E source data, prepares semantic search support, builds (and repairs) local search data, and verifies that Atlas is ready to use.

The installer installs only the atlas CLI. Runtime data stays in user cache locations and is managed by atlas setup.

Release binaries are provided for Linux x64, Linux ARM64, macOS Apple Silicon, and Windows x64. macOS Intel and Windows ARM64 are not published as release binaries yet.

Confirm the installed version:

atlas --version

To install a pinned version, use that release's installer URL:

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/e-kosten/pf2e-atlas/releases/download/v0.1.0/atlas-installer.sh | sh

Release candidates are installed only from pinned URLs or with ATLAS_VERSION.

If you do not want to pipe an installer into a shell, download the cargo-dist archive for your OS from the GitHub releases page, verify it against SHA256SUMS, extract atlas, put it on PATH, then run atlas setup.

Early release binaries are unsigned. macOS or Windows may show an operating-system warning until signing and notarization are added in a later release.

Try It

Search for something by meaning:

atlas search "low level healing spell" --kind spell --limit 5

Resolve a record by name:

atlas record resolve "Treat Wounds" --pack-name actionspf2e

Fetch records by keys (generally retrieved from other results and queries):

atlas record get actionspf2e:1kGNdIIhuglAjIp9
atlas record get equipment-srd:s1vB3HdXjMigYAnY

Explore available filters and nearby record context:

atlas filters fields
atlas similar "Dirge of Doom" --kind spell
atlas graph links actionspf2e:1kGNdIIhuglAjIp9

Agent Skill

The CLI includes a first-party skill that teaches local coding agents how to use Atlas for PF2E lookup, search, filter discovery, and graph context.

Run the interactive installer and choose the agent target you use:

atlas agent skills install

For scripts or setup automation, provide the target and scope directly:

atlas agent skills install --target agents --scope workspace --yes --json

Supported targets are agents, claude, codex, copilot, gemini, and kiro.

To inspect existing installs or diagnose a changed skill directory, use:

atlas agent skills doctor

Maintenance

Check setup status without changing local data:

atlas setup --check

Use already-downloaded data without network access:

atlas setup --offline

Remove selected local data:

atlas setup clean --artifact
atlas setup clean --all --yes

Cleanup supports --artifact, --embeddings, --source-checkout, and --all, with --check for a dry run. Cleanup that selects every target requires --yes unless --check is used.

To remove Atlas completely, first remove runtime data:

atlas setup clean --all --yes

Then remove the atlas binary from the path printed by the installer.

Advanced Data Locations

The default setup stores Atlas data in platform user cache paths, so the installed CLI can be used from any directory after setup.

  • --path-mode global uses the default user cache location under pf2e-atlas.
  • --path-mode repo is a contributor mode that uses paths inside this repository:
    • source: vendor/pf2e
    • embedding model cache: .cache/hf-models
    • SQLite artifact: .cache/pf2e-index.sqlite

You can override locations for a single command:

  • --source /path/to/pf2e
  • --output /path/to/pf2e-index.sqlite
  • --index /path/to/pf2e-index.sqlite
  • --embedding-cache-path /path/to/hf-models

Setup rebuilds or repairs local search data when validation fails, the PF2E source data changes, or the selected embedding model changes.

Automation And JSON

Most commands support --json. Successful command payloads are under data, and command failures are under error.

Artifact validation against an invalid artifact is still a successful command invocation: it returns status: "ok" with data.valid: false and exits with code 3.

Example:

atlas index validate --json

Contributor Index Commands

Standard users should run atlas setup. Manual index commands remain available for development and diagnostics:

cargo run -p atlas-cli -- index analyze --json
cargo run -p atlas-cli -- index build --no-embeddings --json

Use Cargo's release profile for ingest or search performance measurements:

cargo run --release -p atlas-cli -- index analyze --source vendor/pf2e --json

For source installation from a local checkout, install Rust 1.95 or newer and run:

cargo install --path crates/atlas-cli --locked

Further Reading

Contact

For questions about PF2e Atlas, use the GitHub issue tracker.

Paizo Community Use Notice

PF2e Atlas uses trademarks and/or copyrights owned by Paizo Inc., used under Paizo's Community Use Policy (paizo.com/licenses/communityuse). We are expressly prohibited from charging you to use or access this content. PF2e Atlas is not published, endorsed, or specifically approved by Paizo. For more information about Paizo Inc. and Paizo products, visit paizo.com.

Ver o original no GitHub

Bom para

Relacionados