entryscape 1.7.1__tar.gz → 1.7.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {entryscape-1.7.1 → entryscape-1.7.2}/PKG-INFO +10 -10
- {entryscape-1.7.1 → entryscape-1.7.2}/README.md +9 -9
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/__init__.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/app_token_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/auth_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/catalog_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/contact_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/dataservice_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/dataset_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/distribution_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/document_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/entity_type_api.py +7 -7
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/entry_api.py +55 -55
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/idea_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/job_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_class_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_diagram_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_field_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_form_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_namespace_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/model_property_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/organization_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/search_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/showcase_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/suggestion_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/terminology_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/upload_api.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api_client.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/configuration.py +3 -3
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/exceptions.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/__init__.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/app_token.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/app_token_create_request.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/app_token_create_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/app_token_status.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/app_token_verify_request.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configuration_provenance.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configuration_source.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entity_type.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entity_type_role.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entry_list.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entry_parent.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entry_reference.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entry_write.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_entry_write_resource_kind.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_project_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/configured_type_relation.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_list_item.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_list_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_reference.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_type_discovery.py +2 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/entity_type_discovery_module.py +3 -2
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/error.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/facet_field.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/facet_field_values_inner.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/facet_list.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/facet_list_available_inner.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_status.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_status_progress.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_status_value.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/job_warning.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/list_catalogs_entry_type_parameter.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/list_catalogs_graph_type_parameter.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/list_catalogs_resource_type_parameter.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/login_request.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/login_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/metadata_format.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/metadata_request.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/parent_reference.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request_filters.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request_filters_graph_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request_filters_resource_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request_sort.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_request_sort_order.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_result.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_result_graph_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_result_resource_type.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/search_sort_order_parameter.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/terminology_import_mode.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_outcome.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_profile.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_result.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_severity.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/validation_summary.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/models/whoami_response.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/rest.py +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape.egg-info/PKG-INFO +10 -10
- {entryscape-1.7.1 → entryscape-1.7.2}/pyproject.toml +1 -1
- {entryscape-1.7.1 → entryscape-1.7.2}/LICENSE.txt +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api/__init__.py +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/api_response.py +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape/py.typed +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape.egg-info/SOURCES.txt +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape.egg-info/dependency_links.txt +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape.egg-info/requires.txt +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/entryscape.egg-info/top_level.txt +0 -0
- {entryscape-1.7.1 → entryscape-1.7.2}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: entryscape
|
|
3
|
-
Version: 1.7.
|
|
3
|
+
Version: 1.7.2
|
|
4
4
|
Summary: EntryScape API client for Python - provides access to EntryScape data following DCAT-AP standards
|
|
5
5
|
Author-email: Metasolutions <contact@entryscape.com>
|
|
6
6
|
License-Expression: LGPL-3.0-or-later
|
|
@@ -49,8 +49,8 @@ EntryScape API client for Python - provides access to EntryScape data following
|
|
|
49
49
|
|
|
50
50
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
51
51
|
|
|
52
|
-
- API version: 1.7.
|
|
53
|
-
- Package version: 1.7.
|
|
52
|
+
- API version: 1.7.2
|
|
53
|
+
- Package version: 1.7.2
|
|
54
54
|
- Generator version: 7.22.0
|
|
55
55
|
|
|
56
56
|
For more information, please visit [https://entryscape.com/en/contact-us/](https://entryscape.com/en/contact-us/)
|
|
@@ -242,13 +242,13 @@ Class | Method | HTTP request | Description
|
|
|
242
242
|
*DocumentApi* | **get_document_metadata** | **GET** /document/{context_id}/{entry_id}/metadata | Get document metadata
|
|
243
243
|
*DocumentApi* | **list_documents** | **GET** /document | List documents
|
|
244
244
|
*DocumentApi* | **update_document_metadata** | **PUT** /document/{context_id}/{entry_id}/metadata | Update document metadata
|
|
245
|
-
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable
|
|
246
|
-
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured
|
|
247
|
-
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured
|
|
248
|
-
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured
|
|
249
|
-
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured
|
|
250
|
-
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured
|
|
251
|
-
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured
|
|
245
|
+
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable entity types for a context
|
|
246
|
+
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured type
|
|
247
|
+
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured entry
|
|
248
|
+
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured entry reference
|
|
249
|
+
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured entry
|
|
250
|
+
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured type
|
|
251
|
+
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured entry
|
|
252
252
|
*IdeaApi* | **create_idea** | **POST** /idea | Create idea
|
|
253
253
|
*IdeaApi* | **delete_idea** | **DELETE** /idea/{context_id}/{entry_id} | Delete idea
|
|
254
254
|
*IdeaApi* | **get_idea** | **GET** /idea/{context_id}/{entry_id} | Get idea
|
|
@@ -7,8 +7,8 @@ EntryScape API client for Python - provides access to EntryScape data following
|
|
|
7
7
|
|
|
8
8
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
9
9
|
|
|
10
|
-
- API version: 1.7.
|
|
11
|
-
- Package version: 1.7.
|
|
10
|
+
- API version: 1.7.2
|
|
11
|
+
- Package version: 1.7.2
|
|
12
12
|
- Generator version: 7.22.0
|
|
13
13
|
|
|
14
14
|
For more information, please visit [https://entryscape.com/en/contact-us/](https://entryscape.com/en/contact-us/)
|
|
@@ -200,13 +200,13 @@ Class | Method | HTTP request | Description
|
|
|
200
200
|
*DocumentApi* | **get_document_metadata** | **GET** /document/{context_id}/{entry_id}/metadata | Get document metadata
|
|
201
201
|
*DocumentApi* | **list_documents** | **GET** /document | List documents
|
|
202
202
|
*DocumentApi* | **update_document_metadata** | **PUT** /document/{context_id}/{entry_id}/metadata | Update document metadata
|
|
203
|
-
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable
|
|
204
|
-
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured
|
|
205
|
-
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured
|
|
206
|
-
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured
|
|
207
|
-
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured
|
|
208
|
-
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured
|
|
209
|
-
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured
|
|
203
|
+
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable entity types for a context
|
|
204
|
+
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured type
|
|
205
|
+
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured entry
|
|
206
|
+
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured entry reference
|
|
207
|
+
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured entry
|
|
208
|
+
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured type
|
|
209
|
+
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured entry
|
|
210
210
|
*IdeaApi* | **create_idea** | **POST** /idea | Create idea
|
|
211
211
|
*IdeaApi* | **delete_idea** | **DELETE** /idea/{context_id}/{entry_id} | Delete idea
|
|
212
212
|
*IdeaApi* | **get_idea** | **GET** /idea/{context_id}/{entry_id} | Get idea
|
|
@@ -7,14 +7,14 @@ EntryScape API
|
|
|
7
7
|
|
|
8
8
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
9
9
|
|
|
10
|
-
The version of the OpenAPI document: 1.7.
|
|
10
|
+
The version of the OpenAPI document: 1.7.2
|
|
11
11
|
Contact: contact@entryscape.com
|
|
12
12
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
13
13
|
|
|
14
14
|
Do not edit the class manually.
|
|
15
15
|
""" # noqa: E501
|
|
16
16
|
|
|
17
|
-
__version__ = "1.7.
|
|
17
|
+
__version__ = "1.7.2"
|
|
18
18
|
|
|
19
19
|
# Define package exports
|
|
20
20
|
__all__ = [
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@ EntryScape API
|
|
|
3
3
|
|
|
4
4
|
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.7.
|
|
6
|
+
The version of the OpenAPI document: 1.7.2
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -71,9 +71,9 @@ class EntityTypeApi:
|
|
|
71
71
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
72
72
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
73
73
|
) -> EntityTypeDiscovery:
|
|
74
|
-
"""Discover applicable
|
|
74
|
+
"""Discover applicable entity types for a context
|
|
75
75
|
|
|
76
|
-
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective
|
|
76
|
+
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective configuration for the selected EntryStore host, context and caller. The module is derived from the context, never from a request input: a context whose entry information has rdf:type http://entryscape.com/terms/WorkbenchContext (an EntryScape Workbench project) is resolved in the workbench module, every other context in catalog. The response's module states which. Both the resolved host and context are mandatory in a successful response, including when the default host was used. Configured types exist in effective configuration; applicable types also pass the merged context selection and module/global/access filters. Permitted actions require separate authorization: discovery never grants write access. Primary and secondary types come from the merged context selection. A useWith type is offered only if its parent is applicable and its own restrictions pass. Excluded, non-global and invalid types are not selectable. A valid base or relation target may be absent from the result; do not reveal hidden type definitions to complete references. A primary type has neither refines nor useWith; a secondary type has refines but no useWith; a useWith type has a parent, with or without refines. These links do not imply inheritance. Map only the type's own raw rdfType values to rdfTypes. Preserve its own constraints object separately, including any rdf:type constraint; never infer rdfTypes from constraints or a base type. Preserve its own form template reference as an opaque string, not necessarily a URI. The response is not a raw configuration dump. Existing arbitrary RDF search and raw metadata endpoints remain available and are not reimplemented. Authentication is optional for public contexts. Invalid supplied credentials fail with 401; a known unreadable context yields 403, while missing or hidden contexts yield 404. Reauthorize the context and caller on every call. Return Cache-Control: private, no-store; never share a resolved result across callers. Configuration provenance freshness does not promise remote re-fetch on each call, and configurationVersion is not a permission token. Resolution is atomic: absent, unavailable or malformed configuration and unresolved selection must fail, never return a partial or built-in fallback success. A valid configuration with no applicable types may return empty arrays. Errors must not disclose raw URLs, private configuration bodies, exception text, ETags or credentials. The standard Error.code remains the HTTP status; Error.error carries the stable configuration category described below. **Catalog example:** request `GET /entity-types/42?entrystore_host=catalog.example.org/store/` with `Accept: application/json`, anonymously for a public context. The response example below is synthetic, not a real customer configuration.
|
|
77
77
|
|
|
78
78
|
:param context_id: The context (catalog) identifier in EntryStore (required)
|
|
79
79
|
:type context_id: str
|
|
@@ -166,9 +166,9 @@ class EntityTypeApi:
|
|
|
166
166
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
167
167
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
168
168
|
) -> ApiResponse[EntityTypeDiscovery]:
|
|
169
|
-
"""Discover applicable
|
|
169
|
+
"""Discover applicable entity types for a context
|
|
170
170
|
|
|
171
|
-
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective
|
|
171
|
+
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective configuration for the selected EntryStore host, context and caller. The module is derived from the context, never from a request input: a context whose entry information has rdf:type http://entryscape.com/terms/WorkbenchContext (an EntryScape Workbench project) is resolved in the workbench module, every other context in catalog. The response's module states which. Both the resolved host and context are mandatory in a successful response, including when the default host was used. Configured types exist in effective configuration; applicable types also pass the merged context selection and module/global/access filters. Permitted actions require separate authorization: discovery never grants write access. Primary and secondary types come from the merged context selection. A useWith type is offered only if its parent is applicable and its own restrictions pass. Excluded, non-global and invalid types are not selectable. A valid base or relation target may be absent from the result; do not reveal hidden type definitions to complete references. A primary type has neither refines nor useWith; a secondary type has refines but no useWith; a useWith type has a parent, with or without refines. These links do not imply inheritance. Map only the type's own raw rdfType values to rdfTypes. Preserve its own constraints object separately, including any rdf:type constraint; never infer rdfTypes from constraints or a base type. Preserve its own form template reference as an opaque string, not necessarily a URI. The response is not a raw configuration dump. Existing arbitrary RDF search and raw metadata endpoints remain available and are not reimplemented. Authentication is optional for public contexts. Invalid supplied credentials fail with 401; a known unreadable context yields 403, while missing or hidden contexts yield 404. Reauthorize the context and caller on every call. Return Cache-Control: private, no-store; never share a resolved result across callers. Configuration provenance freshness does not promise remote re-fetch on each call, and configurationVersion is not a permission token. Resolution is atomic: absent, unavailable or malformed configuration and unresolved selection must fail, never return a partial or built-in fallback success. A valid configuration with no applicable types may return empty arrays. Errors must not disclose raw URLs, private configuration bodies, exception text, ETags or credentials. The standard Error.code remains the HTTP status; Error.error carries the stable configuration category described below. **Catalog example:** request `GET /entity-types/42?entrystore_host=catalog.example.org/store/` with `Accept: application/json`, anonymously for a public context. The response example below is synthetic, not a real customer configuration.
|
|
172
172
|
|
|
173
173
|
:param context_id: The context (catalog) identifier in EntryStore (required)
|
|
174
174
|
:type context_id: str
|
|
@@ -261,9 +261,9 @@ class EntityTypeApi:
|
|
|
261
261
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
262
262
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
263
263
|
) -> RESTResponseType:
|
|
264
|
-
"""Discover applicable
|
|
264
|
+
"""Discover applicable entity types for a context
|
|
265
265
|
|
|
266
|
-
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective
|
|
266
|
+
**Alpha:** paths and shapes may change, or this operation may be withdrawn, in any release — no deprecation period. Returns a projection of the effective configuration for the selected EntryStore host, context and caller. The module is derived from the context, never from a request input: a context whose entry information has rdf:type http://entryscape.com/terms/WorkbenchContext (an EntryScape Workbench project) is resolved in the workbench module, every other context in catalog. The response's module states which. Both the resolved host and context are mandatory in a successful response, including when the default host was used. Configured types exist in effective configuration; applicable types also pass the merged context selection and module/global/access filters. Permitted actions require separate authorization: discovery never grants write access. Primary and secondary types come from the merged context selection. A useWith type is offered only if its parent is applicable and its own restrictions pass. Excluded, non-global and invalid types are not selectable. A valid base or relation target may be absent from the result; do not reveal hidden type definitions to complete references. A primary type has neither refines nor useWith; a secondary type has refines but no useWith; a useWith type has a parent, with or without refines. These links do not imply inheritance. Map only the type's own raw rdfType values to rdfTypes. Preserve its own constraints object separately, including any rdf:type constraint; never infer rdfTypes from constraints or a base type. Preserve its own form template reference as an opaque string, not necessarily a URI. The response is not a raw configuration dump. Existing arbitrary RDF search and raw metadata endpoints remain available and are not reimplemented. Authentication is optional for public contexts. Invalid supplied credentials fail with 401; a known unreadable context yields 403, while missing or hidden contexts yield 404. Reauthorize the context and caller on every call. Return Cache-Control: private, no-store; never share a resolved result across callers. Configuration provenance freshness does not promise remote re-fetch on each call, and configurationVersion is not a permission token. Resolution is atomic: absent, unavailable or malformed configuration and unresolved selection must fail, never return a partial or built-in fallback success. A valid configuration with no applicable types may return empty arrays. Errors must not disclose raw URLs, private configuration bodies, exception text, ETags or credentials. The standard Error.code remains the HTTP status; Error.error carries the stable configuration category described below. **Catalog example:** request `GET /entity-types/42?entrystore_host=catalog.example.org/store/` with `Accept: application/json`, anonymously for a public context. The response example below is synthetic, not a real customer configuration.
|
|
267
267
|
|
|
268
268
|
:param context_id: The context (catalog) identifier in EntryStore (required)
|
|
269
269
|
:type context_id: str
|