Agenten stärken
Der eigene Befehl des Herausgebers. Kein PlugMCP-Endpunkt.
Host a copy with our keys and logs.
npx -y @honua/[email protected]Claude Code hat keinen Installationslink für einen lokalen Befehl. Kopieren Sie den Befehl unten und führen Sie ihn in einem Terminal aus.
claude mcp add honua-mcp-server -- npx -y @honua/mcp-server@0.6.1In einem Terminal ausführen.
{ "mcpServers": { "honua-mcp-server": { "command": "npx", "args": [ "-y", "@honua/[email protected]" ] } }}claude_desktop_config.json
Remote-URL oder ein Befehl auf Ihrem Rechner? Worin sich die beiden Installationen unterscheiden
Auf PlugMCP ausführen
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
StartenMapLibre renders the map. Honua connects, queries, explains, and mounts the data.
@honua/sdk-js is the integration layer for the open map stack: typed clients for the
protocols your data already speaks (Esri GeoServices, OGC API Features / Tiles / Maps /
Processes, STAC, WMS, WMTS, WFS 2.0, OData v4), a one-call data→map bridge and MapLibre
runtime, provider-pluggable geocoding and routing, and a drop-in ArcGIS compatibility
layer with a codemod. MapLibre is the stable renderer path; the optional Cesium scene
surface is beta on @honua/app-platform, and Kepler.gl integration is experimental.
A new 2D map imports createHonua from @honua/sdk-js and maplibreRenderer from @honua/sdk-js/runtime. Server attach uses HonuaClient from @honua/sdk-js/honua. An ArcGIS app uses @honua/sdk-esri-compat and @honua/honua-migrate. Widget paint registers @honua/app-platform/web-components. @honua/sdk is HonuaClient, not createHonua.
Leaving ArcGIS? Every classic Esri widget was deprecated at ArcGIS JS SDK 5.0 and
removal begins with 6.0 — as early as Q1 2027. If your app constructs one, that code stops
compiling and running when you take the 6.0 upgrade. Run
npm run scan:arcgis:widgets -- ./src for a per-file readiness report, then read the
widget-removal survival guide — every deprecated
widget mapped to its Honua/MapLibre disposition.
Ten application lines. No Honua server, no API key, no account — one lifecycle owner takes a
public Esri Living Atlas FeatureServer through inspection, a bounded query, an explainable plan,
and a styled MapLibre map. MapLibre is a peer you install beside the SDK
(npm install @honua/sdk-js maplibre-gl; see Install):
import { createHonua } from "@honua/sdk-js";
import { maplibreRenderer } from "@honua/sdk-js/runtime";
import * as maplibregl from "maplibre-gl";
const endpoint = "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/2020_Census_State_Apportionment/FeatureServer/0";
await using honua = createHonua();
const data = await honua.connect(endpoint);
const info = await data.inspect();
const plan = await data.explain({ returnGeometry: true, pagination: { limit: 100 } }, { sourceId: info.defaultSourceId });
const result = await data.query(plan);
const map = await data.mount("#map", { renderer: maplibreRenderer(maplibregl), query: plan, sourceId: info.defaultSourceId });
await map.ready;
For those ten lines the kernel owns discovery, the connection, cancellation, and the mounted
map. The same lines run unchanged against Honua's own public demo: set endpoint to
https://demo.honua.io/rest/services/maui-parcels/FeatureServer/1 (anonymous reads,
CORS-open to any origin). result contains bounded execution evidence, while plan explains the accepted query.
Leaving the await using scope disposes the map and connection; every operation also accepts
an AbortSignal for caller cancellation.
Run the canonical inspected workflow with npm run demo:quickstart:mock
(examples/maplibre-quickstart/); the focused lower-level cookbook
is docs/data-to-map-bridge.md.
For an application that opens more than one source, keep the same instance-scoped owner:
import { createHonua } from "@honua/sdk-js";
const honua = createHonua({ discoveryCacheMaxEntries: 128 });
try {
const data = await honua.connect(
"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/2020_Census_State_Apportionment/FeatureServer/0",
);
const inspection = await data.inspect();
const source = data.source<{ NAME: string; Seats_2020: number }>();
console.log(inspection.cacheStatus, source.descriptor.id);
} finally {
await honua.dispose();
}
inspect() reuses the immutable snapshot established by connect();
inspect({ refresh: true, signal }) revalidates it. Service roots with more
than one source require an explicit sourceId in the locator/options or in
source(id)—the kernel never chooses the first advertised source silently.
Release status: beta (0.2.10). The 22-entrypoint stable tier is guarded
by an API-surface gate; 26 experimental subpaths may change before 1.0, and
19 deprecated compatibility subpaths have explicit removal versions. See
config/support-manifest.v1.json for the versioned support truth,
config/public-surface.json for its generated package projection,
support/projections/sdk-support.v1.json for the generic
site/sample consumer contract, and
the scope decision.
This README tracks the current development branch. The version above is its package baseline, not a claim that every capability described here is already present in the npm artifact with that version. For published behavior, use the tagged release documentation.
📚 Hosted docs: honua-io.github.io/honua-sdk-js — quickstart, the full guide corpus, the TypeDoc API reference, and the demo gallery.
The rendering war is settled — MapLibre is the open 2D engine of record and Cesium owns
open 3D. What the open stack has been missing is the layer above the renderer: service
clients, styling, interactions, editing, geocoding, migration tooling — the glue every
team hand-rolls. That integration layer is what @honua/sdk-js owns:
Source.query(...) call works against
GeoServices, OGC, WFS, OData and friends. Geoprocessing uses one IJobRun
lifecycle across raw OGC API Processes and Esri-compatible GPServer tasks.
Capability misses throw
HonuaCapabilityNotSupportedError instead of returning empty results. Large
results ride an experimental columnar data plane (GeoArrow batches, streaming
backpressure, worker-side aggregation —
docs/columnar-data-plane.md).connect() + mountSource() turn a bare endpoint into a
styled, interactive MapLibre layer; loadMapPackage(...) + HonuaMapRuntime render
server-authored MapPackages; createTemporalPlayback and the
<honua-time-slider> control animate time-enabled sources. This is the stable renderer path. OGC web-map support
follows the generated capability matrix; Cesium integration lives on the beta
@honua/app-platform/scene-workspace path — see the
surface tiers table for the
exports it covers and the ones still experimental — and @honua/sdk-js/kepler is
experimental.strict + verbatimModuleSyntax, exported types for every public
symbol, declaration maps, and JSDoc on the public client surface.FeatureLayerCompat, MapImageLayerCompat, MapViewCompat,
SceneViewCompat, WebMapCompat, LocatorCompat (provider-pluggable geocoding, no
server required), and a safe codemod (honua-migrate) keep existing ArcGIS
code running while you cut over.docs/geocoding-routing-providers.md).
That candor is applied to Honua itself: every capability carries a generated
open-endpoint or server-attach tier, and each server-attach capability names a
roadmap issue for an open-endpoint path or why the dependency is inherent
(capability tiers).The honest comparisons are the service-client libraries, not the renderers:
@esri/arcgis-rest-js — that's Esri's own client for Esri services only. Honua speaks
GeoServices plus OGC API / WFS / WMS / WMTS / STAC / OData under one typed contract, with a
capability model that throws instead of returning silently-empty results.esri-leaflet — dormant (no release since September 2025) and Leaflet-bound. Honua's
client-compat + honua-migrate codemod is an actively maintained migration path that targets
MapLibre.openlayers / maplibre-gl directly — pick those when you need a renderer and are
happy hand-rolling service calls; pick Honua on top of MapLibre when you want the typed
client, the ArcGIS migration path, or the server-authored MapPackage runtime.The numbers behind those claims — generated bundle sizes, a protocol-coverage matrix and an
operation-level behaviour table against raw MapLibre / @esri/arcgis-rest-js / OpenLayers, and
a scripted time-to-first-map benchmark with a runnable repro (npm run bench:ttfm) — live in
docs/comparison.md. That page names the category boundary behind
every column (headless client vs renderer vs all-in-one SDK) and backs each external figure
with a dated, primary-sourced evidence record; a measurement of a superseded release line is
labelled historical and is barred, in code, from supporting a current claim.
Two deployment tiers, named up front. 28 of the 36 generated support
claims are open-endpoint: they run against standards-speaking endpoints you already
have, or entirely in the client and build — no Honua account, no Honua Server.
8 are server-attach and execute only after attaching to a Honua Server facade;
1 of those link a roadmap issue for an open-endpoint path and the rest state why the
server dependency is inherent, in the generated
capability tiers table.
Honua Server is optional for standards clients. Supported GeoServices, OGC API
Features, WFS 2.0, WMS 1.3, WMTS 1.0, STAC, and OData claims work against raw standards-speaking endpoints.
OGC API Tiles (beta), Maps (beta), and Records
(beta) also discover and use raw advertised paths. OGC API Processes
keeps two honest lanes against a raw server:
discovery (supported, standalone) and
typed execution (experimental, standalone).
A Honua Server adds server-authored
MapPackages, realtime, collaboration, compatibility metadata, a richer hosted
/mcp operator catalog, and the facade-required execution paths. See the generated
backend-agnostic capability matrix for every
claim's tier, execution mode, and evidence link.
In the spirit of the migration punch list, the non-goals are explicit rather than implied:
beta 3D scene surface rides
CesiumJS as a lazily imported peer.
Honua does not fork, wrap-and-hide, or compete with either. If you need renderer
features (custom shaders, globe projections, visual effects), take them from the
renderer directly — Honua stays out of the way.SceneViewCompat covers 2D-safe behavior only, and 3D-only widgets (e.g. Daylight)
are honestly marked no-equivalent in the
widget survival guide. For SceneView-class 3D, use
CesiumJS or stay on the
ArcGIS Maps SDK for that part of
your app./offline subpath now ships a real browser
engine — an IndexedDB region store, a durable edit queue with proven
offline-capture / reload / replay, region tile and asset serving, and quota
admission (docs/offline-regions.md,
docs/examples/offline-region-reference) —
but it is still an experimental subpath, hosted replica sync does not exist,
and it stays outside the 1.0 narrative until both change.npm install @honua/sdk-js maplibre-gl
maplibre-gl is the renderer the map examples on this page mount into. Leave it out if you
only query data (Node services, the honua CLI).
Runtime support, stated up front:
Security — pick maplibre-gl 6.4.1 or newer. GHSA-jrc7-96c5-q579 is a critical XSS sanitizer bypass in
DOM.sanitize()affecting everymaplibre-glat or below 6.4.0, patched in 6.4.1 with no backport to 5.x. The peer range above is^6.4.1, so affected 5.x and 6.0.0 through 6.4.0 releases do not satisfy it.
Starting from scratch? create-honua-app scaffolds a working app instead of
assembling peers — a Vite + TypeScript (or React) starter that already connects
to an endpoint and mounts a source, pinned to a published SDK version and
rendering a committed fixture on the first npm run dev. The package is
published on npm, so npm create honua-app is the shortest supported path;
both starters also open in a browser playground with no install at all — see
docs/playgrounds.md and
docs/create-honua-app.md.
Everything documented here ships in @honua/sdk-js as subpath entrypoints
(see INSTALL.md). Focused standalone packages are also
published from this repository for consumers who only want a subset:
The SDK split builds exist for packaging workflows and subset consumers;
details in docs/split-packages.md. Existing
@honua/sdk-js/migration imports follow the
migration-tool transition policy.
For static sites, prototypes, or CSP-strict pages that can't run a bundler, a
prebuilt browser bundle is published under dist/browser/. Drop in the
minified IIFE build and use the global window.HonuaSDK:
<script src="https://cdn.jsdelivr.net/npm/@honua/sdk-js/dist/browser/honua-sdk.min.js"></script>
<script>
const client = new HonuaSDK.HonuaClient({ baseUrl: "https://your-honua-server.example" });
// window.HonuaSDK exposes the same public API as `import ... from "@honua/sdk-js"`.
</script>
Or, for native ES module imports via an ESM CDN:
<script type="module">
import { HonuaClient } from "https://esm.sh/@honua/sdk-js/browser";
const client = new HonuaClient({ baseUrl: "https://your-honua-server.example" });
</script>
The runtime peers (maplibre-gl, cesium, @bufbuild/*, @connectrpc/*) are
kept external — load them yourself when you need map rendering or gRPC
transport. See docs/browser-bundle.md for details.
Honest about size: every subpath entrypoint carries a min+gzip byte budget that
CI enforces on every PR (npm run verify:bundle-budgets), so drift fails the
build instead of shipping. Sizes are measured the way a consumer builds —
esbuild --bundle --minify, runtime peers external. The excerpt below is
generated from that measurement, tree-shake guards included:
The root is the whole reviewed kernel and the guards price its verbs honestly: importing { connect }
alone costs 163.1 KiB gzip and { createHonua } 192.1 KiB against the 202.7 KiB root, so size-sensitive
apps should import the focused subpaths rather than the root. Full per-entrypoint
table (min + gzip, generated): docs/bundle-sizes.md;
refresh the table and this excerpt together with npm run report:bundle-sizes.
For how these sizes sit against @arcgis/core and friends — at a named category
boundary, with every external figure dated and primary-sourced — see the
generated comparison page.
No Honua server required. This runs against a public Esri GeoServices endpoint — no API key, no account, no infrastructure — and walks the kernel's verbs in order: connect → query → explain (the fourth verb, mount, is the hero at the top of this page).
import { connect, explainQuery, envelope, queryFilter, type Query } from "@honua/sdk-js";
// 1. connect — a public Esri Living Atlas FeatureServer; nothing of Honua's is running.
const data = await connect({
endpoint:
"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/2020_Census_State_Apportionment/FeatureServer/0",
protocol: "auto",
authorizationScopeFingerprint: "public",
});
const states = data.source<{ NAME: string; Total_Pop_2020: number }>();
// 2. query — one typed, protocol-neutral filter expression.
const query: Query = {
filter: queryFilter.and(
queryFilter.gt("Total_Pop_2020", 1_000_000),
queryFilter.spatial("intersects", envelope(-125, 24, -66, 50, { wkid: 4326 })),
),
outFields: ["NAME", "Total_Pop_2020"],
pagination: { limit: 100 },
};
// 3. explain — the serializable plan, inspectable before anything executes.
const plan = explainQuery({ descriptor: states.descriptor, query });
console.log(plan.fingerprint, plan.steps.map((step) => `${step.engine}:${step.operation}`));
const result = await states.queryAll(query);
console.log(`Loaded ${result.features.length} states`);
envelope, point, and polygon default to WGS84 (4326). Pass the input
spatial reference for projected coordinates. GeoServices query serialization
emits inSR from geometry metadata (or defaults untagged geometry to 4326);
an explicit extraParams.inSR takes precedence for low-level requests. Invalid
explicit geometry references throw instead of using the layer CRS.
Query.filter compiles to GeoServices SQL-92, CQL2, FES 2.0, OData $filter,
or DuckDB SQL, and Query.temporalFilter compiles to the protocol's own time
parameter (time=, datetime=) or an exact predicate on a named field. A
construct the target cannot express throws HonuaCapabilityNotSupportedError
naming the construct and the protocol — it is never silently dropped or
widened. explainQuery returns the same plan surface agents and the
honua explain CLI command use: compiled predicates, bounds, cache and
fidelity decisions, all serializable. Assembling a Dataset by hand — explicit
protocol, locator, and capabilities, no discovery — is covered in
docs/guide.md.
The deprecated Query.where member remains operational only as source-native
v1 migration compatibility; its grammar changes with the adapter, so new code
should use Query.filter. The experimental
@honua/sdk-js/query-planner adds a schema-verified
builder and explain plans over the same filter shape.
The same query envelope works against any GeoServices, OGC API
Features, WFS, OData, or STAC endpoint. Migrating from esri-leaflet? The raw
GeoServices API remains available, but its where member below is explicitly
GeoServices SQL rather than the deprecated protocol-neutral Query.where:
import { HonuaClient } from "@honua/sdk-js";
const geoServicesClient = new HonuaClient({
baseUrl: "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis",
});
const { features } = await geoServicesClient.queryFeatures({
serviceId: "2020_Census_State_Apportionment",
layerId: 0,
where: "1=1",
outFields: ["*"],
returnGeometry: true,
resultRecordCount: 25,
});
Run the complete First Map app locally — public endpoint in, inspected MapLibre map out. The
app lives in this repository, so clone it first (Node.js >=22.12 and git):
git clone --depth 1 https://github.com/honua-io/honua-sdk-js.git
cd honua-sdk-js
npm ci
Then run the fixture lane from the clone, and return to where you started:
npm run demo:quickstart:mock -- --evidence-once # build, serve the fixture, probe it once, exit (what CI runs)
cd ..
To keep the fixture server running instead, go back into the clone (cd honua-sdk-js), run
npm run demo:quickstart:mock without -- --evidence-once, and open the printed
quickstartMockUrl in a browser. From the clone, npm run demo:quickstart starts the same app
on a live anonymous public endpoint that you paste or configure.
See docs/quickstart.md for the canonical
guided server-optional walkthrough,
docs/standalone-capability-matrix.md
for the backend-agnostic vs server-enhanced breakdown, and
examples/maplibre-quickstart/
for the committed source.
A Honua Server unlocks
server-authored MapPackages (loadMapPackage()), realtime subscriptions,
collaboration / saved maps, and the MCP + AI surfaces. Point the same code at a
local server (docker compose up in a honua-server checkout), and gate
production reads on the compatibility check:
const { supported, reasons } = await client.checkCompatibility();
if (!supported) throw new Error(`Unsupported Honua server: ${reasons.join("; ")}`);
The server-connected lane is the maplibre-quickstart
example (npm run demo:quickstart:mock); see
docs/quickstart.md and
docs/quickstart-troubleshooting.md.
honua)For local geoprocessing development, honua gp delegates to the separately
installed Honua.Geoprocessing.Cli engine. Follow the
GP authoring guide
to install honua-gp-devkit, then put it on PATH or set HONUA_GP_CLI to its
executable path. No engine is automatically downloaded.
honua gp doctor --managed-only --json
honua gp list --json
honua gp describe geometry.buffer --json
The engine receives arguments literally and owns output and exit codes; a launch
failure returns 127. These local commands do not require a server URL or add
a backend selector to server submissions. honua doctor remains the separate
support-bundle command. The proprietary honua-gp compatibility tool is
not the devkit executable.
Installing the SDK also installs a first-class honua CLI — the same
querying and catalog browsing without writing code. It wraps the SDK (no raw
HTTP, no URL-encoding, no f=json), prints readable tables by default, and adds
--json / --format geojson for machine output.
npm i -g @honua/sdk-js # or, without installing: npx -p @honua/sdk-js honua <command>
export HONUA_BASE_URL=https://demo.honua.io # anonymous reads on the public demo
honua services # list published services
honua layers maui-parcels # list a service's layers
honua query maui-parcels/1 --count
honua query maui-parcels/1 --limit 1 --format json # one feature: shows the layer's fields
honua query maui-parcels/1 --where "zone = '1'" --limit 5
honua query maui-parcels/1 --bbox -156.7,20.7,-156.3,21.0 --format geojson
honua explain maui-parcels/1 --bbox -156.7,20.7,-156.3,21.0 --json # the plan, no server call
honua stac collections
honua geocode "1 Honolulu Pl, HI"
honua tiles maui-parcels 12/912/1809 -o tile.png
Render a map image of a bounding box:
honua map export maui-parcels --bbox -156.7,20.7,-156.3,21.0 --size 800x600 -o maui.png
The CLI's --where takes the source-native filter grammar by design (SQL for
GeoServices, CQL2 for OGC) — it is a command-line convenience, not the
deprecated protocol-neutral Query.where; honua explain shows exactly what
any query compiles to before it runs. Authentication resolves from
--api-key, HONUA_API_KEY, or a saved honua login. For an existing OAuth/operator
bearer, set HONUA_BEARER_TOKEN; the CLI sends that caller token through its normal
SDK adapters and never saves it. Credentials supplied explicitly take precedence
over the environment. An environment bearer replaces saved API/Admin keys and
HONUA_ADMIN_KEY; a rejected bearer never falls back to those keys. Set only one
of HONUA_API_KEY and HONUA_BEARER_TOKEN. honua whoami reports the selected
authentication scheme without printing the credential. Run honua --help for
the full command surface. This is the recommended command surface for docs and
demos.
The npx form needs -p: npx resolves its first argument as a package and
then picks a bin from it, and this package publishes two (honua and
honua-plugin-certify), neither named sdk-js — so npx @honua/sdk-js honua
fails with "could not determine executable to run" before it ever reads honua.
Naming the package with -p leaves the next word as the command.
For support-safe interoperability evidence, honua doctor emits a local,
schema-validated diagnostic bundle with explicit classification/consent,
credential and PII redaction, bounded previews, and original-byte SHA-256
metadata. honua doctor --replay permits only one bounded, abortable
GET/HEAD and fails closed before network access for mutations,
subscriptions, unsafe paths, credentials, malformed schemas, or hash drift. It
never uploads. See docs/diagnostic-bundles.md.
The versioned SDK sample catalog tracks all 34 executable examples: 4 qualified golden samples, 13 recipes, 14 labs, and 3 fixtures. Seven journey IDs are reserved; 3 remain explicitly planned candidates. The catalog is the source of truth for track, support, lifecycle, fixture/live evidence, quality profiles, and the honua.io projection.
Linking to Honua from a plugin directory or ecosystem list? Point at
First Map
(hosted walkthrough,
source) — CI keeps its fixture lane externally network-blocked and its
release smoke green across Chromium, Firefox, and WebKit. Reusable directory entries — and the
ledger of which ecosystem submissions were filed and accepted — live in
docs/listings/maplibre-plugin-directory.md.
Whether any of that actually makes the packages findable is measured, not assumed:
docs/listings/npm-search-verification.md records
where every published @honua/* package ranks in npm registry search for its declared discovery
terms, including the queries where it does not rank at all.
Dataset → Source → Query → ResultEvery Honua SDK — JavaScript, Python, .NET — speaks the same canonical
vocabulary. A Dataset groups one or more Sources. Each Source accepts a
protocol-neutral Query and returns a protocol-neutral Result. Operations the
canonical surface does not cover stay reachable through the typed
source.protocol(...) escape hatch. Method casing differs by language
(queryAll() / query_all() / QueryAllAsync()), the semantics do not.
Capability misses throw HonuaCapabilityNotSupportedError (under the default
strict policy) rather than silently returning empty results. See the
60-second quickstart above for the runnable shape; the
cross-language semantics, protocol/capability identifiers, language-binding
tables, and backwards-compatibility policy live in:
docs/sdk-surface-alignment.md — cross-language naming + semverdocs/shared-client-contract.md — contract designdocs/protocol-capability-matrix.md — what each protocol supportsFull documentation index — every published page, generated from the documentation bundle so it cannot drift.
docs/generated/learning-paths.md — task-oriented progression backed by runnable examples and checked SDK imports
docs/quickstart.md — guided quickstart walkthrough
docs/guide.md — long-form reference (server compatibility, subpath
entrypoints, OGC / WFS / OData cookbooks, MapLibre runtime, migration CLI, request/auth bridge)
docs/errors.md — error class reference + retry policy
docs/shared-client-contract.md — Dataset / Source / Query / Result design
docs/protocol-capability-matrix.md — what each protocol supports
docs/sdk-surface-alignment.md — cross-language naming & semver policy
docs/maplibre-runtime.md — loadMapPackage() / HonuaMapRuntime
docs/data-to-map-bridge.md — connect() → mountSource() standalone bridge cookbook
docs/react.md — React bindings (@honua/react): provider, hooks, and map components
docs/geometry.md — @honua/sdk-js/geometry curated turf/proj4 ops (buffer/area/measure/simplify/reproject) + the geometryEngine compat shim
docs/geoprocessing.md — one job lifecycle across OGC API Processes, Esri GPServer compatibility, and AI-selected operations
docs/zero-to-map-release-journey.md — contract-first 2026.1 install → admin → buffer → Studio → share URL walkthrough
docs/geocoding-routing-providers.md — provider-pluggable geocoding & routing adapters
docs/studio-package-contracts.md — Studio package-family projections, validation envelope, capability manifest (@honua/app-platform/studio)
docs/features/README.md — capability snapshot
docs/docs-samples-ownership.md — SDK/site ownership boundary for versioned docs and executable samples
docs/documentation-snippets.md — supported code-fence validation and explicit pseudocode directives
INSTALL.md — install + subpath entrypoint table
Platform-wide documentation (server concepts, deployment, Esri migration) lives at honua.gitbook.io/honuaio.
Run npm run docs:learning:verify from a fresh checkout to build the SDK and
validate learning-path metadata, internal links, generated Markdown, and runtime
imports. CI reuses its existing build with the internal
npm run docs:learning:check command, then separately compiles every selected
example through npm run docs:learning:typecheck.
Run npm run docs:snippets:verify to build the public declarations and validate
all supported JavaScript and TypeScript documentation fences.
Coding agents (Claude Code, Cursor, and compatible assistants) can discover and correctly use this SDK:
llms.txt — a curated llms.txt index
of the docs, plus llms-full.txt with the full corpus
concatenated for single-fetch ingestion. Both are generated from docs/ +
README.md + entrypoint JSDoc by npm run docs:llms (freshness-checked in CI
via npm run verify:llms).skills/ — honua-sdk-quickstart,
honua-geoservices-migration, and honua-mcp-setup load procedural instructions
into Claude Code and compatible agents. See skills/README.md
for installation.@honua/mcp-server is the platform-free
geospatial MCP server: point honua-mcp at any public ArcGIS FeatureServer
or OGC API endpoint (no Honua server required) and it exposes discovery, query,
and analysis tools to assistants over the Model Context Protocol. Its tool
contract is the SDK's own protocol-neutral one — sources are addressed as
<protocol>:<address> (ogc-features:hotels, stac:sentinel-2-l2a,
wfs:topp:states, odata:People, geoservices-feature-service:Parks/0),
filters are the typed semantic filter, and geometry is GeoJSON, so no tool
schema requires an Esri-only field. Tools that need a Honua-only surface
degrade gracefully with a structured "not available on this target" result, and
a request the backing protocol cannot express returns a structured capability
error rather than an empty result. A Honua deployment's richer /mcp catalog is
the upgrade path via honua-mcp-proxy.docs/generated/mcp-eval-scorecard.md.
Every figure is generated from the committed, dated run artifacts under
mcp/evals/runs/ — with the zero-LLM deterministic control row,
every non-passing run, and the protocol-certification failures included, because
a wins-only scoreboard is marketing.@honua/sdk-js/nl-map-control
compiles natural-language instructions into serializable, inspectable plans
(query-planner IR plus agent-tool invocations) through a caller-provided LLM
callback — no model-vendor SDK. Execution accepts plans only: read-only
plans may auto-execute under policy, anything mutating or viewport-changing
requires a signed agent-safety approval envelope, and every execution emits a
receipt. The same tool surface is published in MCP and OpenAI function
formats.context7.json registers the library so
Context7 serves current docs to coding agents; the
submission steps are in skills/README.md.docs/coding-agent-evals.md; latest results
in docs/generated/coding-agent-scorecard.md.connect → query → explain → mount workflow. Protocol-specific clients,
renderers, app state, styling, migration, realtime, offline, and analytics
APIs remain supported from focused subpaths; no advanced API was deleted. The
exact root inventory and every former-root replacement are published in
config/root-surface.json and the generated
root import migration table.INSTALL.md.@experimental in JSDoc may change in any minor release. The full table of
stable and experimental subpaths lives in INSTALL.md. The short version:
@honua/sdk-js, @honua/sdk-js/browser,
@honua/sdk-js/honua, @honua/sdk-js/auth, @honua/sdk-js/contract,
@honua/sdk-js/client-compat, @honua/sdk-js/migration,
@honua/sdk-js/runtime, @honua/sdk-js/expr, @honua/sdk-js/webmap,
@honua/sdk-js/geocoding, @honua/sdk-js/exploration, @honua/sdk-js/interactions,
@honua/sdk-js/filter-registry, @honua/sdk-js/style, @honua/sdk-js/map,
@honua/sdk-js/realtime, @honua/sdk-js/react, @honua/sdk-js/geometry,
@honua/sdk-js/cli, @honua/sdk-js/agent-tools, @honua/sdk-js/agent-safety.
The agent surface's security posture is documented in the
agent-safety threat model./nl-map-control, /studio-agent, /interactions/declarative, /geoparquet, /source-schema, /source-capabilities, /source-capability-discovery, /cloud-native-discovery, /plugin, /deckgl,
/offline, /diagnostics, /routing, /cog, /pmtiles, /stac, /raster, /coverages, /columnar-workflow, /kepler, /analytics, /analytics/uplot, /zarr,
/pmtiles-protocol-plugin.js, /local-install — with /query-planner below, 26 experimental subpaths in total./query-planner subpath remains experimental. The stable root promotes a
reviewed query-planner subset: explainQuery, executeQueryPlan, hashQueryPlan, the plan
errors/version constants, and the types required to name the common explain/mount workflow./app, /app-controller, /app-workspace,
/scene-workspace, /collaboration, /control-plane, /replica-sync, /share,
/operate, /generated-app, /studio, /controls, /web-components, /operator,
/operator/*) have moved to the separate @honua/app-platform package; the old
18 deprecated compatibility subpaths remain through 0.2.x and are removed in
0.3.0. The /console entrypoint was removed outright (no shim).
@honua/app-platform/scene-workspace is the first of those replacements promoted to
beta: the renderer-neutral workspace state, the scene primitive contract, and
the Cesium primitive adapter carry a shape commitment through 0.1.x, while Honua
Server scene discovery, SceneView, the analysis widgets, and the bounded
Source-to-Cesium-entity slice stay experimental. The split is enumerated export by
export in the generated
surface tiers table.We publish a lifecycle because a library you build on should tell you what it promises.
esri-leaflet never did, and "will this break under me?" is the question that decides adoption.
0.x). The stable tier — the subpath entrypoints listed under
"Stable subpath entrypoints" in INSTALL.md — is where we invest
compatibility effort, and it is guarded in CI by a public-API report
(npm run verify:api-report): no symbol leaves or changes shape by accident. While we are
on 0.x a minor may still change a stable symbol, but only as a reviewed, called-out
change — never silently. Symbols marked @experimental in JSDoc may change in any minor.
Symbols marked @beta sit between the two: they carry a named shape commitment for the
stated range and grow additively, and breaking one is a called-out change. A barrel that
mixes tiers enumerates every export in the generated
surface tiers table, so no symbol
inherits a tier from its neighbours.@honua/app-platform package that versions at
its own pre-1.0 cadence, so the client SDK can reach a frozen 1.0 without waiting on them.
Their old @honua/sdk-js/* subpaths remain as @deprecated re-export shims through
0.2.x and are removed in 0.3.0 — promoting a replacement (the Cesium scene surface is
now beta) does not extend or shorten a forwarder's removal window. See
docs/decisions/scope-split-and-1.0.md.Long-form reference material now lives in docs/guide.md:
checkCompatibility() contract@experimental tierMapPackage runtime + Generated App preview runtimehonua-migrate CLI, admin scanner, parity matrix, sample-corpus harnessProtocol-specific deep dives also live alongside the guide: see
docs/wfs.md, docs/ogc-api.md,
docs/maplibre-runtime.md,
docs/webmap-json-compatibility.md,
docs/protocol-capability-matrix.md,
docs/migration-punch-list.md, and
docs/widget-survival-guide.md (every ArcGIS widget
deprecated at 5.0 mapped to its Honua/MapLibre disposition ahead of the 6.0 removal — run
npm run scan:arcgis:widgets -- ./src for a per-file readiness report).
This SDK ships from a single repository: the canonical package is
@honua/sdk-js (all subpath entrypoints in INSTALL.md live
under that name), with the standalone packages in the table above built from
the same source tree. The MCP server lives in mcp/.
See AGENTS.md for contributor instructions and the Specifica
issue format used for backlog items.
HonuaClient refuses to send an apiKey, bearerToken or auth provider
credential over plain http:// to a non-loopback host; use https://, a
loopback URL for local development, or opt in with allowInsecureHttp: true
(see docs/auth.md
for the migration note).
Report vulnerabilities to [email protected] — see the org security policy. Please do not open public issues for security reports.
Platform-free MCP server for geospatial services: expose discovery, query, and analysis over any public GeoServices REST feature service or OGC API endpoint to any MCP client, with no platform lock-in
{ "mcpServers": { "honua-mcp-server": { "command": "npx", "args": [ "-y", "@honua/[email protected]" ] } }}Tools
Noch keine Tool-Liste. Remote-Server erhalten eine nach dem ersten Health-Check.
FAQ
Kopieren Sie auf dieser Seite die stdio-Konfiguration für Cursor, Claude Desktop, Claude Code oder VS Code. Sie nutzt die Installation des Herausgebers, keinen PlugMCP-Proxy.
In diesem Eintrag ist keine erforderliche Umgebungsvariable aufgeführt.
@honua/ läuft lokal über stdio.
Zuletzt geprüft: 2026-11-14. Platform-free MCP server for geospatial services: expose discovery, query, and analysis over any public GeoServices REST feature service or OGC API endpoint to any MCP client, with no platform lock-in