APIs
APIs registered on the Neptune DXP - Open Edition platform are exposed through MCP as read-only. The MCP server provides tools to list and inspect APIs, but there are no tools to create, modify, or delete an API. Use the Cockpit for write operations.
Required role: apidesigner.
If your user account does not have this role, every tool in this group fails immediately with an access denied error. Contact an administrator to request the role, or see Access control for more information on how roles are enforced.
Available tools
Parameters are shown with their type and a short description. UUIDs are always strings.
| Tool | Description | Parameters | ||
|---|---|---|---|---|
|
List all APIs in Neptune DXP - Open Edition. Returns a summary per API (id, name, description, endpoint, type, version, group, package).
|
None |
||
|
Return detailed information about an API, including its endpoints, paths, and definitions. |
|
||
|
Create or update an API. Pass the full API object. Omit |
|
||
|
Delete an API by its ID. |
|
Related topics
-
Tools overview — the full list of artifact types and required roles.
-
Access control — how role and development package checks are enforced on every tool call.
-
Cockpit overview — use the Cockpit to create, modify, or delete APIs.