entryscape 1.7.3__tar.gz → 1.8.0__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.
Files changed (107) hide show
  1. {entryscape-1.7.3 → entryscape-1.8.0}/PKG-INFO +14 -8
  2. {entryscape-1.7.3 → entryscape-1.8.0}/README.md +13 -7
  3. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/__init__.py +13 -3
  4. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/app_token_api.py +2 -2
  5. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/auth_api.py +2 -2
  6. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/catalog_api.py +20 -20
  7. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/contact_api.py +8 -8
  8. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/dataservice_api.py +8 -8
  9. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/dataset_api.py +14 -14
  10. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/distribution_api.py +8 -8
  11. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/document_api.py +8 -8
  12. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/entity_type_api.py +5 -5
  13. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/entry_api.py +14 -11
  14. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/idea_api.py +8 -8
  15. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/job_api.py +2 -2
  16. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_api.py +2 -2
  17. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_class_api.py +2 -2
  18. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_diagram_api.py +2 -2
  19. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_field_api.py +2 -2
  20. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_form_api.py +2 -2
  21. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_namespace_api.py +2 -2
  22. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/model_property_api.py +2 -2
  23. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/organization_api.py +8 -8
  24. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/search_api.py +8 -8
  25. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/showcase_api.py +8 -8
  26. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/suggestion_api.py +8 -8
  27. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/terminology_api.py +5 -5
  28. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/upload_api.py +2 -2
  29. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api_client.py +3 -3
  30. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/configuration.py +4 -4
  31. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/exceptions.py +2 -2
  32. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/__init__.py +7 -2
  33. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/app_token.py +2 -2
  34. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/app_token_create_request.py +2 -2
  35. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/app_token_create_response.py +2 -2
  36. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/app_token_status.py +2 -2
  37. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/app_token_verify_request.py +2 -2
  38. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configuration_provenance.py +2 -2
  39. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configuration_source.py +2 -2
  40. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entity_type.py +19 -2
  41. entryscape-1.8.0/entryscape/models/configured_entity_type_resource_kinds_inner.py +36 -0
  42. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entity_type_role.py +2 -2
  43. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entry_list.py +2 -2
  44. entryscape-1.8.0/entryscape/models/configured_entry_parent.py +124 -0
  45. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entry_reference.py +16 -3
  46. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entry_write.py +27 -5
  47. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_entry_write_resource_kind.py +3 -3
  48. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_project_type.py +2 -2
  49. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/configured_type_relation.py +33 -3
  50. entryscape-1.8.0/entryscape/models/configured_type_relation_type.py +35 -0
  51. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_list_item.py +2 -2
  52. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_list_response.py +2 -2
  53. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_reference.py +2 -2
  54. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_type.py +3 -3
  55. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_type_discovery.py +2 -2
  56. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/entity_type_discovery_module.py +4 -3
  57. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/error.py +24 -2
  58. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/facet_field.py +2 -2
  59. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/facet_field_values_inner.py +2 -2
  60. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/facet_list.py +2 -2
  61. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/facet_list_available_inner.py +2 -2
  62. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_response.py +2 -2
  63. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_status.py +2 -2
  64. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_status_progress.py +2 -2
  65. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_status_value.py +2 -2
  66. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_type.py +2 -2
  67. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/job_warning.py +2 -2
  68. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/list_catalogs_entry_type_parameter.py +2 -2
  69. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/list_catalogs_graph_type_parameter.py +2 -2
  70. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/list_catalogs_resource_type_parameter.py +2 -2
  71. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/login_request.py +2 -2
  72. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/login_response.py +2 -2
  73. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/metadata_format.py +2 -2
  74. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/metadata_request.py +2 -2
  75. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/parent_reference.py +2 -2
  76. entryscape-1.7.3/entryscape/models/configured_entry_parent.py → entryscape-1.8.0/entryscape/models/referencing_entry.py +7 -7
  77. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request.py +2 -2
  78. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request_filters.py +2 -2
  79. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request_filters_graph_type.py +2 -2
  80. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request_filters_resource_type.py +2 -2
  81. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request_sort.py +2 -2
  82. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_request_sort_order.py +2 -2
  83. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_response.py +2 -2
  84. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_result.py +2 -2
  85. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_result_graph_type.py +2 -2
  86. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_result_resource_type.py +2 -2
  87. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/search_sort_order_parameter.py +2 -2
  88. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/terminology_import_mode.py +2 -2
  89. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_outcome.py +2 -2
  90. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_profile.py +2 -2
  91. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_response.py +2 -2
  92. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_result.py +2 -2
  93. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_severity.py +2 -2
  94. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/validation_summary.py +2 -2
  95. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/models/whoami_response.py +2 -2
  96. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/rest.py +2 -2
  97. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape.egg-info/PKG-INFO +14 -8
  98. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape.egg-info/SOURCES.txt +3 -0
  99. {entryscape-1.7.3 → entryscape-1.8.0}/pyproject.toml +1 -1
  100. {entryscape-1.7.3 → entryscape-1.8.0}/LICENSE.txt +0 -0
  101. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api/__init__.py +0 -0
  102. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/api_response.py +0 -0
  103. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape/py.typed +0 -0
  104. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape.egg-info/dependency_links.txt +0 -0
  105. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape.egg-info/requires.txt +0 -0
  106. {entryscape-1.7.3 → entryscape-1.8.0}/entryscape.egg-info/top_level.txt +0 -0
  107. {entryscape-1.7.3 → entryscape-1.8.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: entryscape
3
- Version: 1.7.3
3
+ Version: 1.8.0
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.3
53
- - Package version: 1.7.3
52
+ - API version: 1.8.0
53
+ - Package version: 1.8.0
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/)
@@ -72,13 +72,16 @@ pip install entryscape
72
72
 
73
73
  Every release is also published as `python-sdk.tar.gz` at
74
74
  <https://api.entryscape.com/sdk/latest/python-sdk.tar.gz>, for a build that cannot reach
75
- PyPI or has to vendor its dependencies:
76
-
77
- The archive has no top-level directory of its own, so unpack it into one:
75
+ PyPI or has to vendor its dependencies. Its SHA-256 is in `SHA256SUMS` beside it; check the
76
+ download before unpacking (on macOS, `shasum -a 256 -c`). The archive has no top-level
77
+ directory of its own, so unpack it into one:
78
78
 
79
79
  ```bash
80
- mkdir entryscape-python && tar -xzf python-sdk.tar.gz -C entryscape-python
81
- pip install ./entryscape-python
80
+ curl -fLO https://api.entryscape.com/sdk/latest/python-sdk.tar.gz &&
81
+ curl -fLO https://api.entryscape.com/sdk/latest/SHA256SUMS &&
82
+ grep ' python-sdk.tar.gz$' SHA256SUMS | sha256sum -c &&
83
+ mkdir entryscape-python && tar -xzf python-sdk.tar.gz -C entryscape-python &&
84
+ pip install ./entryscape-python
82
85
  ```
83
86
 
84
87
  ## Quick Start
@@ -340,6 +343,7 @@ Class | Method | HTTP request | Description
340
343
  - `ConfigurationProvenance`
341
344
  - `ConfigurationSource`
342
345
  - `ConfiguredEntityType`
346
+ - `ConfiguredEntityTypeResourceKindsInner`
343
347
  - `ConfiguredEntityTypeRole`
344
348
  - `ConfiguredEntryList`
345
349
  - `ConfiguredEntryParent`
@@ -348,6 +352,7 @@ Class | Method | HTTP request | Description
348
352
  - `ConfiguredEntryWriteResourceKind`
349
353
  - `ConfiguredProjectType`
350
354
  - `ConfiguredTypeRelation`
355
+ - `ConfiguredTypeRelationType`
351
356
  - `EntityListItem`
352
357
  - `EntityListResponse`
353
358
  - `EntityReference`
@@ -373,6 +378,7 @@ Class | Method | HTTP request | Description
373
378
  - `MetadataFormat`
374
379
  - `MetadataRequest`
375
380
  - `ParentReference`
381
+ - `ReferencingEntry`
376
382
  - `SearchRequest`
377
383
  - `SearchRequestFilters`
378
384
  - `SearchRequestFiltersGraphType`
@@ -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.3
11
- - Package version: 1.7.3
10
+ - API version: 1.8.0
11
+ - Package version: 1.8.0
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/)
@@ -30,13 +30,16 @@ pip install entryscape
30
30
 
31
31
  Every release is also published as `python-sdk.tar.gz` at
32
32
  <https://api.entryscape.com/sdk/latest/python-sdk.tar.gz>, for a build that cannot reach
33
- PyPI or has to vendor its dependencies:
34
-
35
- The archive has no top-level directory of its own, so unpack it into one:
33
+ PyPI or has to vendor its dependencies. Its SHA-256 is in `SHA256SUMS` beside it; check the
34
+ download before unpacking (on macOS, `shasum -a 256 -c`). The archive has no top-level
35
+ directory of its own, so unpack it into one:
36
36
 
37
37
  ```bash
38
- mkdir entryscape-python && tar -xzf python-sdk.tar.gz -C entryscape-python
39
- pip install ./entryscape-python
38
+ curl -fLO https://api.entryscape.com/sdk/latest/python-sdk.tar.gz &&
39
+ curl -fLO https://api.entryscape.com/sdk/latest/SHA256SUMS &&
40
+ grep ' python-sdk.tar.gz$' SHA256SUMS | sha256sum -c &&
41
+ mkdir entryscape-python && tar -xzf python-sdk.tar.gz -C entryscape-python &&
42
+ pip install ./entryscape-python
40
43
  ```
41
44
 
42
45
  ## Quick Start
@@ -298,6 +301,7 @@ Class | Method | HTTP request | Description
298
301
  - `ConfigurationProvenance`
299
302
  - `ConfigurationSource`
300
303
  - `ConfiguredEntityType`
304
+ - `ConfiguredEntityTypeResourceKindsInner`
301
305
  - `ConfiguredEntityTypeRole`
302
306
  - `ConfiguredEntryList`
303
307
  - `ConfiguredEntryParent`
@@ -306,6 +310,7 @@ Class | Method | HTTP request | Description
306
310
  - `ConfiguredEntryWriteResourceKind`
307
311
  - `ConfiguredProjectType`
308
312
  - `ConfiguredTypeRelation`
313
+ - `ConfiguredTypeRelationType`
309
314
  - `EntityListItem`
310
315
  - `EntityListResponse`
311
316
  - `EntityReference`
@@ -331,6 +336,7 @@ Class | Method | HTTP request | Description
331
336
  - `MetadataFormat`
332
337
  - `MetadataRequest`
333
338
  - `ParentReference`
339
+ - `ReferencingEntry`
334
340
  - `SearchRequest`
335
341
  - `SearchRequestFilters`
336
342
  - `SearchRequestFiltersGraphType`
@@ -5,16 +5,16 @@
5
5
  """
6
6
  EntryScape API
7
7
 
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
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. `SHA256SUMS` beside the archives holds their SHA-256 sums; check a download with `grep ' <archive>$' SHA256SUMS | sha256sum -c` before unpacking it: - **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` and `SHA256SUMS` from the SDK downloads, check the archive and unpack it. The package ships prebuilt; install its runtime dependency once: ``` grep ' mcp-server.tar.gz$' SHA256SUMS | sha256sum -c && 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.3
10
+ The version of the OpenAPI document: 1.8.0
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.3"
17
+ __version__ = "1.8.0"
18
18
 
19
19
  # Define package exports
20
20
  __all__ = [
@@ -60,6 +60,7 @@ __all__ = [
60
60
  "ConfigurationProvenance",
61
61
  "ConfigurationSource",
62
62
  "ConfiguredEntityType",
63
+ "ConfiguredEntityTypeResourceKindsInner",
63
64
  "ConfiguredEntityTypeRole",
64
65
  "ConfiguredEntryList",
65
66
  "ConfiguredEntryParent",
@@ -68,6 +69,7 @@ __all__ = [
68
69
  "ConfiguredEntryWriteResourceKind",
69
70
  "ConfiguredProjectType",
70
71
  "ConfiguredTypeRelation",
72
+ "ConfiguredTypeRelationType",
71
73
  "EntityListItem",
72
74
  "EntityListResponse",
73
75
  "EntityReference",
@@ -93,6 +95,7 @@ __all__ = [
93
95
  "MetadataFormat",
94
96
  "MetadataRequest",
95
97
  "ParentReference",
98
+ "ReferencingEntry",
96
99
  "SearchRequest",
97
100
  "SearchRequestFilters",
98
101
  "SearchRequestFiltersGraphType",
@@ -173,6 +176,9 @@ from entryscape.models.configuration_source import (
173
176
  from entryscape.models.configured_entity_type import (
174
177
  ConfiguredEntityType as ConfiguredEntityType,
175
178
  )
179
+ from entryscape.models.configured_entity_type_resource_kinds_inner import (
180
+ ConfiguredEntityTypeResourceKindsInner as ConfiguredEntityTypeResourceKindsInner,
181
+ )
176
182
  from entryscape.models.configured_entity_type_role import (
177
183
  ConfiguredEntityTypeRole as ConfiguredEntityTypeRole,
178
184
  )
@@ -197,6 +203,9 @@ from entryscape.models.configured_project_type import (
197
203
  from entryscape.models.configured_type_relation import (
198
204
  ConfiguredTypeRelation as ConfiguredTypeRelation,
199
205
  )
206
+ from entryscape.models.configured_type_relation_type import (
207
+ ConfiguredTypeRelationType as ConfiguredTypeRelationType,
208
+ )
200
209
  from entryscape.models.entity_list_item import EntityListItem as EntityListItem
201
210
  from entryscape.models.entity_list_response import (
202
211
  EntityListResponse as EntityListResponse,
@@ -238,6 +247,7 @@ from entryscape.models.login_response import LoginResponse as LoginResponse
238
247
  from entryscape.models.metadata_format import MetadataFormat as MetadataFormat
239
248
  from entryscape.models.metadata_request import MetadataRequest as MetadataRequest
240
249
  from entryscape.models.parent_reference import ParentReference as ParentReference
250
+ from entryscape.models.referencing_entry import ReferencingEntry as ReferencingEntry
241
251
  from entryscape.models.search_request import SearchRequest as SearchRequest
242
252
  from entryscape.models.search_request_filters import (
243
253
  SearchRequestFilters as SearchRequestFilters,
@@ -1,9 +1,9 @@
1
1
  """
2
2
  EntryScape API
3
3
 
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
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. `SHA256SUMS` beside the archives holds their SHA-256 sums; check a download with `grep ' <archive>$' SHA256SUMS | sha256sum -c` before unpacking it: - **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` and `SHA256SUMS` from the SDK downloads, check the archive and unpack it. The package ships prebuilt; install its runtime dependency once: ``` grep ' mcp-server.tar.gz$' SHA256SUMS | sha256sum -c && 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.3
6
+ The version of the OpenAPI document: 1.8.0
7
7
  Contact: contact@entryscape.com
8
8
  Generated by OpenAPI Generator (https://openapi-generator.tech)
9
9
 
@@ -1,9 +1,9 @@
1
1
  """
2
2
  EntryScape API
3
3
 
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
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. `SHA256SUMS` beside the archives holds their SHA-256 sums; check a download with `grep ' <archive>$' SHA256SUMS | sha256sum -c` before unpacking it: - **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` and `SHA256SUMS` from the SDK downloads, check the archive and unpack it. The package ships prebuilt; install its runtime dependency once: ``` grep ' mcp-server.tar.gz$' SHA256SUMS | sha256sum -c && 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.3
6
+ The version of the OpenAPI document: 1.8.0
7
7
  Contact: contact@entryscape.com
8
8
  Generated by OpenAPI Generator (https://openapi-generator.tech)
9
9