Skip to main content
Glama
anylogic-docs

anylogic-docs

by goya02-ops

anylogic-docs-mcp

Servidor MCP que le da a un agente de IA (opencode, Claude Code, Cursor, Codex…) la documentación real de AnyLogic 8.9 para que consulte en vez de inventar: bloques, propiedades, firmas de la API Java, tutoriales y ejemplos.

Todo se consulta en local: el servidor sólo abre un índice SQLite y unos ficheros Markdown. No hay red en tiempo de consulta.

Solo Unix. Este proyecto está pensado para Linux y macOS. En Windows requiere WSL2 con entorno gráfico (el crawler abre una ventana de navegador). No está probado de forma nativa en Windows.


El problema que resuelve

Sin documentación a mano, un agente improvisa:

— "Para cambiar la prioridad de un Seize, usa seize.setPriority(5)." ❌ Ese método no existe.

Con este MCP, busca primero y cita:

— "Seize tiene el campo priority de tipo double; se define con public double priority(T agent) y cuanto mayor, antes se atiende la tarea. Fuente: https://anylogic.help/api/com/anylogic/libraries/processmodeling/Seize.html"

Eso es todo lo que hace: convierte "creo que la API es así" en "la API es así, aquí está".


Related MCP server: cryosparc-docs-mcp

Cómo funciona

   anylogic.help  ──crawl──┐
   (964 páginas)           │
                           ├──►  corpus/*.md  ──►  index.db  ──►  servidor MCP  ──►  agente
   javadoc de AnyLogic ────┘     (Markdown)      (SQLite FTS5)      (stdio)
   (1.066 clases)
  1. API — se lee del javadoc que ya viene instalado con AnyLogic (sin red).

  2. Guía — se descarga una vez de anylogic.help (necesita red, ver aviso abajo).

  3. Conversión — todo se normaliza a Markdown limpio: tablas, código, listas de propiedades de cada bloque, imágenes.

  4. Índice — se construye index.db con búsqueda de texto (BM25 de SQLite FTS5, sin embeddings ni modelos).

  5. Servidor — server/main.py expone 7 herramientas MCP sobre ese índice.


Requisitos previos

Esto no es un paquete que se instala y listo: genera tu propia copia local de la documentación. Antes de empezar, comprueba que tienes todo esto.

Requisito

Versión

Cómo comprobarlo

Para qué

Si falta

Sistema operativo

Linux o macOS

uname -s

todo el proyecto

en Windows usa WSL2 con entorno gráfico

Python

3.12 o superior

python3 --version

servidor MCP y conversores

no arranca nada

uv

última

uv --version

crear el entorno e instalar dependencias

el instalador usa python3 -m venv + pip (más lento, funciona igual)

Node.js

20 o superior

node --version

crawler (fetch y WebSocket nativos)

no se puede descargar la guía (queda solo la API)

Chrome / Chromium

120 o superior

node scripts/crawl.mjs --check

abrir la web real y superar Cloudflare

el crawl falla

AnyLogic

8.9.x instalado

debe existir ~/Applications/AnyLogic-8.9.9 (Linux) o /Applications/AnyLogic*.app (macOS)

de ahí salen los javadoc de la API

tendrías guía pero sin referencia de API

Conexión a internet

—

—

descargar anylogic.help (~300 MB)

solo funciona la parte de API, que es offline

Espacio en disco

~1 GB libre

df -h .

venv (60 MB) + HTML (215 MB) + imágenes (76 MB) + índice (40 MB)

el proceso se corta a medias

Entorno gráfico

X11, Wayland o macOS

—

Chromium necesita ventana visible para el challenge

el crawl no pasa Cloudflare

Tiempo total de la primera instalación: 10–15 minutos (API ~1 min, descarga de la guía ~10 min, índice ~1 min).

Navegadores válidos: Chrome, Chromium, Brave o Edge (cualquier binario basado en Chromium). Si no está en el PATH, se indica con ANYLOGIC_CHROME.


Instalación

git clone https://github.com/goya02-ops/anylogic-docs-mcp.git
cd anylogic-docs-mcp
./install.sh

Eso es todo. El script crea el entorno, genera el corpus y el índice, y termina con una verificación automática.

Opciones

Comando

Qué hace

Cuándo usarlo

./install.sh

API + descarga de la guía + índice

instalación normal

./install.sh --api-only

solo API, sin red

ya tienes la guía, o no quieres descargar nada

./install.sh --skip-crawl

reutiliza lo ya descargado en raw/html

reinstalar sin volver a bajar

./install.sh --no-images

descarga la guía sin imágenes

ahorra ~4 minutos y 76 MB

./install.sh --skip-api

solo guía

no tienes AnyLogic instalado

./install.sh --register

registra el MCP en los clientes que detecte

tras instalar

./install.sh --print-config <cliente>

imprime la config con rutas reales

para copiar a mano o a otra máquina

./install.sh --wsl

variante para agente en Windows y repo en WSL

Windows

Qué hace exactamente

  1. Comprueba sistema operativo, Python 3.12+, Node 20+ y el navegador.

  2. Crea .venv e instala mcp[cli], beautifulsoup4 y lxml.

  3. scripts/convert_api.py → lee el javadoc de tu AnyLogic y genera corpus/api/.

  4. scripts/crawl.mjs --images → descarga la guía de anylogic.help en raw/html/.

  5. scripts/convert_guide.py → HTML a Markdown en corpus/guide/.

  6. scripts/build_index.py → construye index.db (~37.000 fragmentos).

  7. scripts/selftest.py → comprobaciones de búsqueda, API y configuración de clientes.

Si no encuentra AnyLogic, aborta y te dice cómo indicar la ruta, porque sin la API el MCP pierde la mitad de su valor. Si sólo quieres la guía, usa --skip-api.


Aviso: la instalación descarga la documentación

La primera ejecución de ./install.sh descarga 964 páginas y unas 3.000 imágenes de anylogic.help (~300 MB). Es una descarga única: después todo se consulta en local, sin internet.

  • Abre una ventana de Chromium. No es un error. Cloudflare bloquea la descarga automática normal, así que el crawler usa un navegador real. Si aparece un challenge ("Just a moment…" / "Un momento…"), complétalo a mano en esa ventana: el script continúa solo.

  • Es reanudable. Si se corta, vuelve a ejecutarlo: salta lo que ya está descargado.

  • Respeta robots.txt y va a ~2 páginas por segundo.

  • Solo una vez por versión de AnyLogic. Cuando actualices AnyLogic, repite ./install.sh.

  • Este repositorio no incluye la documentación. Es de The AnyLogic Company; cada uno genera su copia para uso personal. No la subas ni la redistribuyas.


Registro en el cliente MCP

El servidor habla stdio: todos los clientes hacen lo mismo, lanzar <repo>/.venv/bin/python <repo>/server/main.py. Solo cambia el formato del fichero.

No hace falta escribir rutas a mano: el instalador las conoce.

./install.sh --print-config all      # la config de todos los clientes, con rutas reales
./install.sh --print-config cursor   # solo uno
./install.sh --register              # registra en los clientes que detecte

--register usa la CLI oficial cuando existe (opencode, claude, codex) y, en los demás, fusiona la entrada en su JSON haciendo copia de seguridad (.bak) sin tocar el resto de servidores.

Cliente

Dónde vive

Cómo

opencode

~/.config/opencode/opencode.json

opencode mcp add

Claude Code

~/.claude.json

claude mcp add -s user

Codex CLI

~/.codex/config.toml

codex mcp add o TOML

Cursor

~/.cursor/mcp.json

JSON (mcpServers)

VS Code (Copilot)

~/.config/Code/User/mcp.json

JSON (servers, type: stdio)

Antigravity

~/.gemini/config/mcp_config.json

JSON (mcpServers)

otros

el que sea

JSON mcpServers

opencode

opencode mcp add anylogic-docs --global -- \
  /ruta/a/anylogic-docs-mcp/.venv/bin/python \
  /ruta/a/anylogic-docs-mcp/server/main.py

Comprobar: opencode mcp list → ✓ anylogic-docs connected.

Claude Code

claude mcp add anylogic-docs -s user -- \
  /ruta/a/anylogic-docs-mcp/.venv/bin/python \
  /ruta/a/anylogic-docs-mcp/server/main.py

-s user lo deja disponible en todos los proyectos (-s project lo guarda en .mcp.json del repo). Comprobar: claude mcp list.

Codex CLI

codex mcp add anylogic-docs -- \
  /ruta/a/anylogic-docs-mcp/.venv/bin/python \
  /ruta/a/anylogic-docs-mcp/server/main.py

O a mano en ~/.codex/config.toml:

[mcp_servers.anylogic-docs]
command = "/ruta/a/anylogic-docs-mcp/.venv/bin/python"
args = ["/ruta/a/anylogic-docs-mcp/server/main.py"]

Cursor

~/.cursor/mcp.json (o .cursor/mcp.json dentro de un proyecto):

{
  "mcpServers": {
    "anylogic-docs": {
      "command": "/ruta/a/anylogic-docs-mcp/.venv/bin/python",
      "args": ["/ruta/a/anylogic-docs-mcp/server/main.py"]
    }
  }
}

Luego, en Cursor: Settings → MCP y activa anylogic-docs (a veces hay que pulsar el refresco).

VS Code (Copilot Chat)

~/.config/Code/User/mcp.json (Linux), ~/Library/Application Support/Code/User/mcp.json (macOS) o .vscode/mcp.json en el proyecto:

{
  "servers": {
    "anylogic-docs": {
      "type": "stdio",
      "command": "/ruta/a/anylogic-docs-mcp/.venv/bin/python",
      "args": ["/ruta/a/anylogic-docs-mcp/server/main.py"]
    }
  }
}

Ojo: VS Code usa servers y exige "type": "stdio". Después: Ctrl+Shift+P → MCP: List Servers → arrancar.

Google Antigravity

~/.gemini/config/mcp_config.json (global, compartido por el IDE y la CLI) o <proyecto>/.agents/mcp_config.json (solo ese workspace):

{
  "mcpServers": {
    "anylogic-docs": {
      "command": "/ruta/a/anylogic-docs-mcp/.venv/bin/python",
      "args": ["/ruta/a/anylogic-docs-mcp/server/main.py"]
    }
  }
}

No añadas "type" en este fichero: Antigravity rechaza el campo.

Cualquier otro cliente

Pide el JSON genérico y pégalo donde tu cliente guarde los servidores:

./install.sh --print-config generic

Windows: agente en Windows y repo en WSL

Si el agente corre nativo en Windows pero el repo está dentro de WSL, el comando no es el python de Linux sino wsl.exe:

./install.sh --wsl --print-config cursor     # o claude, codex, vscode...
./install.sh --wsl --distro Ubuntu --register

Genera esto:

{
  "mcpServers": {
    "anylogic-docs": {
      "command": "wsl.exe",
      "args": [
        "-d", "Ubuntu", "--",
        "/home/tu-usuario/anylogic-docs-mcp/.venv/bin/python",
        "/home/tu-usuario/anylogic-docs-mcp/server/main.py"
      ]
    }
  }
}

Funciona, pero stdio a través de wsl.exe es más frágil (arranques lentos, cierres raros). Recomendado: instalar el agente también dentro de WSL y registrarlo ahí sin --wsl.

Si AnyLogic está instalado en Windows, el javadoc se lee desde WSL por /mnt/c:

.venv/bin/python scripts/convert_api.py --anylogic "/mnt/c/Program Files/AnyLogic 8.9.9"

Comprobar que funciona

  1. Reinicia el cliente (no basta con recargar la ventana en algunos).

  2. Pídele: "usa anylogic_version y dime qué tienes indexado".

  3. Debe responder con la versión, el número de páginas y de clases. Si dice que no existe la herramienta, el servidor no arrancó: revisa la ruta del .venv/bin/python y que index.db exista (./install.sh).

Opcional: que el agente sepa cuándo consultar

El MCP da las herramientas, pero no obliga a usarlas. Copia examples/AGENTS.md a tu AGENTS.md (opencode, Codex), CLAUDE.md (Claude Code) o GEMINI.md (Antigravity), o añade el bloque a mano:

## AnyLogic

Antes de afirmar cómo funciona un bloque, una propiedad o una firma de la API:

1. `anylogic_search("términos en inglés")` → `anylogic_read(path, heading)`.
2. Para código: `anylogic_api("Clase.miembro")`. Si no existe, no lo inventes.
3. La documentación está en inglés; responde en español y cita la URL.
4. Este entorno es AnyLogic PLE 8.9.9: hay funciones (export a Java, librerías
   propias, tamaño de modelo) que no están disponibles.

Herramientas

Herramienta

Para qué

Cuándo usarla

anylogic_search(query, scope?, section?, limit?)

búsqueda BM25 en guía + API

siempre, es el punto de entrada

anylogic_read(path, heading?, max_chars?)

lee una página o una sección

tras una búsqueda, para no tragarse la página entera

anylogic_api(symbol, max_chars?)

ficha exacta de clase/método/campo con firma Java

antes de escribir código

anylogic_api_search(query, limit?)

búsqueda acotada a la API

cuando sólo quieres firmas

anylogic_examples(query, limit?)

ejemplos en tutoriales y modelado avanzado

para ver código real de un patrón

anylogic_toc(scope?, section?)

mapa de secciones y paquetes

cuando no sabes dónde vive un tema

anylogic_version()

versión y tamaño del corpus

para comprobar que el índice está generado

scope acepta "guide" (guía de usuario) o "api" (referencia Java).

Ejemplo de uso real

anylogic_search("seize priority")
  → Seize › Task priority (guía) + Seize.priority (API)

anylogic_read("guide/library-reference-guides/process-modeling-library/seize.md",
              heading="Number of units")
  → sección concreta: tipo, valor por defecto, variables locales

anylogic_api("Seize.priority")
  → public double priority ( T agent)
    "The priority of the task for the incoming agent (the larger the higher)."

Cómo busca

BM25 de SQLite FTS5, sin embeddings. Ajustes que importan en la práctica:

  • Nombre de bloque primero. Si la consulta coincide con el título de una página (Seize, ResourcePool, Conveyor), esa página va arriba aunque su texto no repita la palabra.

  • AND y luego OR. Primero exige todos los términos; si no hay nada, relaja.

  • Cobertura. Entre los resultados sube el fragmento que contiene más términos distintos de la consulta, y más si están en el título.

  • Stemmer mínimo. recurring encuentra recurrence, capacities encuentra capacity (FTS5 no trae stemming).

  • Sesgo de guía (×1.25). La guía explica el bloque; la API da la firma.

  • Máximo 2 fragmentos por página, para no repetir la misma fuente.

La documentación está en inglés: busca en inglés (seize capacity, no capacidad de seize).


Mantenimiento

Actualizar a una versión nueva de AnyLogic

./install.sh          # re-descarga lo que falte y regenera todo
./update.sh           # equivalente (alias)

Si sólo cambió AnyLogic y quieres refrescar la API (offline, rápido):

.venv/bin/python scripts/convert_api.py
.venv/bin/python scripts/build_index.py

Reconstruir sólo el índice

.venv/bin/python scripts/build_index.py

Comprobar que todo sigue bien

.venv/bin/python scripts/selftest.py

Variables de entorno útiles

Variable

Para qué

Por defecto

ANYLOGIC_HOME

ruta de la instalación de AnyLogic

autodetectada

ANYLOGIC_CHROME

binario de Chrome/Chromium

autodetectado

ANYLOGIC_CDP_PORT

puerto de depuración del crawler

9333

ANYLOGIC_PROFILE

perfil del navegador

.chrome-profile/

ANYLOGIC_DOCS_HOME

otra copia del corpus/índice

la del repo


Problemas típicos

Síntoma

Causa

Solución

No encontré Chrome ni Chromium

no hay navegador en el PATH

instálalo (sudo dnf install chromium, brew install --cask google-chrome) o export ANYLOGIC_CHROME=/ruta/al/binario

Cloudflare no cedió

challenge no resuelto

complétalo en la ventana abierta; si insiste, rm -rf .chrome-profile y reintenta con --delay 0.5

Chromium no abrió el puerto de depuración

perfil bloqueado o puerto ocupado

rm -rf .chrome-profile y/o ANYLOGIC_CDP_PORT=9336 ./install.sh

No encontré una instalación de AnyLogic

ruta no estándar

.venv/bin/python scripts/convert_api.py --anylogic /ruta/AnyLogic-8.9.9 o export ANYLOGIC_HOME=...

No existe el índice en ...

falta generar el corpus

./install.sh

El cliente no ve la herramienta

servidor mal registrado o sin reiniciar

./install.sh --print-config <cliente> y revisa la ruta absoluta del python

spawn wsl.exe ENOENT

agente en Windows sin WSL en el PATH

instala el agente dentro de WSL, o usa --wsl --distro <tu-distro>

disk I/O error al reconstruir

otra sesión tiene el índice abierto

cierra el agente y reintenta; el índice se reemplaza de forma atómica

Búsquedas en español devuelven poco

la documentación está en inglés

busca en inglés (arrival rate, no tasa de llegada)

Faltan imágenes

enlaces roscos en la propia web de AnyLogic

se registran en logs/image_failures.json; no afecta al texto

El crawl va lento

~2 páginas/s es lo normal

es una descarga única; se puede reanudar


Estructura del repositorio

anylogic-docs-mcp/
├── server/main.py          # servidor MCP (stdio), 7 herramientas
├── scripts/
│   ├── crawl.mjs           # descarga anylogic.help con Chromium por CDP
│   ├── convert_api.py      # javadoc de AnyLogic → Markdown + símbolos
│   ├── convert_guide.py    # HTML → Markdown
│   ├── build_index.py      # corpus → index.db (FTS5)
│   ├── mcp_config.py       # config MCP de cada cliente (imprimir / registrar)
│   └── selftest.py         # comprobaciones de búsqueda, API y config
├── install.sh              # instalación completa (idempotente)
├── examples/AGENTS.md      # bloque para que el agente consulte antes de afirmar
├── NOTICE.md               # aviso: la licencia MIT no cubre la documentación
├── update.sh               # alias de install.sh para actualizar
├── requirements.txt
└── pyproject.toml

Generado en local, no versionado (ver .gitignore):

corpus/          # Markdown de la guía y de la API
raw/             # HTML e imágenes descargados (caché reanudable)
index.db         # índice de búsqueda
.venv/           # entorno Python
logs/            # fallos de crawl e imágenes
.chrome-profile/ # perfil del navegador usado por el crawler

  • Código: MIT (ver LICENSE).

  • Documentación: la guía, el javadoc y las imágenes son propiedad de The AnyLogic Company y están sujetos a sus términos de uso. Este repositorio no los distribuye: los scripts los generan en tu máquina a partir de tu propia instalación de AnyLogic y del sitio público anylogic.help, para uso personal. Detalle en NOTICE.md.

  • No redistribuyas corpus/, raw/ ni index.db.

  • El crawler respeta robots.txt y va deliberadamente despacio.

Available Tools

7 tools
anylogic_apiB

Devuelve la ficha exacta de una clase, método o campo de la API Java.

Args: symbol: nombre simple ("Seize"), cualificado ("com.anylogic.libraries.processmodeling.Seize") o miembro ("Seize.take", "Agent.getEngine").

Inputs: symbol (required), max_chars. Returns: result

anylogic_examplesB

Busca ejemplos y fragmentos de código en tutoriales y modelado avanzado.

Args: query: concepto o API, p.ej. "resource pool animation", "statechart transition". limit: número máximo de resultados.

Inputs: query (required), limit. Returns: result

anylogic_readA

Lee una página o una sección concreta del corpus.

Args: path: ruta relativa devuelta por anylogic_search, p.ej. "guide/anylogic/3d/3d-object.md" o "api/com/anylogic/engine/Agent.md". heading: si se indica, devuelve sólo esa sección (coincidencia parcial). max_chars: recorte máximo del resultado.

Inputs: path (required), heading, max_chars. Returns: result

anylogic_tocA

Mapa de la documentación: secciones, paquetes y páginas disponibles.

Args: scope: "guide" o "api". Vacío = resumen de ambos. section: para la guía, prefijo de sección a detallar (p.ej. "anylogic/process-modeling-library"). Para la API, un paquete.

Inputs: scope, section. Returns: result

anylogic_versionA

Versión del corpus, número de documentos y fecha de construcción.

Inputs: no named parameters. Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.7/5.0

    Scored across 7 tools

    Disambiguation4/5

    Each tool has a mostly distinct role: read, search, exact API lookup, API search, examples search, TOC, and version. The main possible confusion is between anylogic_search with scope=api and anylogic_api_search, but the descriptions clarify that the latter targets Java class/method signatures.

    Naming Consistency3/5

    All names use the same anylogic_ prefix and lowercase snake_case, which is predictable. However, the suffixes mix verbs (read, search) with nouns (api, examples, toc, version), so the set does not follow a consistent verb_noun convention.

    Tool Count5/5

    Seven tools is well scoped for a documentation/API search server. Each tool covers a distinct retrieval mode: search, read, API lookup, example search, TOC, and corpus metadata.

    Completeness5/5

    The surface covers the full documentation workflow: discovering structure via TOC, searching guides/API/examples, reading pages or sections, and retrieving exact Java symbols. Version metadata is also present, leaving no obvious dead ends for the stated purpose.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      C
      maintenance
      Enables local-first natural language querying of JMP 19.1 documentation, returning menu paths, step-by-step instructions, citations, and relevant figures. Runs fully offline via Ollama and exposes tools for searching, browsing, fetching pages, and locating examples.
      10
      1
      MIT