Can I use ShipEngine as a CLI?

Yes. KosmoKrator exposes a ShipEngine CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose ShipEngine through MCP?

Yes. The KosmoKrator MCP gateway can expose selected ShipEngine tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are ShipEngine credentials stored?

ShipEngine credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for ShipEngine MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

ShipEngine MCP, CLI, and Lua Integration for AI Agents

ShipEngine integration docs for AI agents: MCP gateway setup, ShipEngine CLI commands, Lua API reference, credentials, and function schemas.

ShipEngine for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

ShipEngine CLIHeadless setup, JSON output, direct function calls. ShipEngine MCPExpose selected tools to local MCP clients. ShipEngine LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug: shipengine
route_slug: shipengine
package: shipengine
auth_strategy: api_key
cli_setup_supported: true
cli_runtime_supported: true
mcp_gateway_supported: true
lua_supported: true

Function Catalog

Function	Type	Parameters	Description
`shipengine.shipengine_list_account_settings`	Read `read`	0	List Account Settings Official ShipEngine endpoint: GET /v1/account/settings.
`shipengine.shipengine_list_account_images`	Read `read`	0	List Account Images Official ShipEngine endpoint: GET /v1/account/settings/images.
`shipengine.shipengine_create_account_image`	Write `write`	1	Create an Account Image Official ShipEngine endpoint: POST /v1/account/settings/images.
`shipengine.shipengine_get_account_settings_images_by_id`	Read `read`	1	Get Account Image By ID Official ShipEngine endpoint: GET /v1/account/settings/images/{label_image_id}.
`shipengine.shipengine_update_account_settings_images_by_id`	Write `write`	2	Update Account Image By ID Official ShipEngine endpoint: PUT /v1/account/settings/images/{label_image_id}.
`shipengine.shipengine_delete_account_image_by_id`	Write `write`	1	Delete Account Image By Id Official ShipEngine endpoint: DELETE /v1/account/settings/images/{label_image_id}.
`shipengine.shipengine_parse_address`	Read `read`	1	Parse an address Official ShipEngine endpoint: PUT /v1/addresses/recognize.
`shipengine.shipengine_validate_address`	Read `read`	1	Validate An Address Official ShipEngine endpoint: POST /v1/addresses/validate.
`shipengine.shipengine_list_batches`	Read `read`	10	List Batches Official ShipEngine endpoint: GET /v1/batches.
`shipengine.shipengine_create_batch`	Write `write`	1	Create A Batch Official ShipEngine endpoint: POST /v1/batches.
`shipengine.shipengine_get_batch_by_external_id`	Read `read`	1	Get Batch By External ID Official ShipEngine endpoint: GET /v1/batches/external_batch_id/{external_batch_id}.
`shipengine.shipengine_delete_batch`	Write `write`	1	Delete Batch By Id Official ShipEngine endpoint: DELETE /v1/batches/{batch_id}.
`shipengine.shipengine_get_batch_by_id`	Read `read`	1	Get Batch By ID Official ShipEngine endpoint: GET /v1/batches/{batch_id}.
`shipengine.shipengine_update_batch`	Write `write`	1	Update Batch By Id Official ShipEngine endpoint: PUT /v1/batches/{batch_id}.
`shipengine.shipengine_add_to_batch`	Write `write`	2	Add to a Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/add.
`shipengine.shipengine_list_batch_errors`	Read `read`	3	Get Batch Errors Official ShipEngine endpoint: GET /v1/batches/{batch_id}/errors.
`shipengine.shipengine_process_batch`	Read `read`	2	Process Batch ID Labels Official ShipEngine endpoint: POST /v1/batches/{batch_id}/process/labels.
`shipengine.shipengine_remove_from_batch`	Write `write`	2	Remove From Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/remove.
`shipengine.shipengine_list_carriers`	Read `read`	0	List Carriers Official ShipEngine endpoint: GET /v1/carriers.
`shipengine.shipengine_get_carrier_by_id`	Read `read`	1	Get Carrier By ID Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}.
`shipengine.shipengine_disconnect_carrier_by_id`	Read `read`	1	Disconnect Carrier by ID Official ShipEngine endpoint: DELETE /v1/carriers/{carrier_id}.
`shipengine.shipengine_add_funds_to_carrier`	Write `write`	2	Add Funds To Carrier Official ShipEngine endpoint: PUT /v1/carriers/{carrier_id}/add_funds.
`shipengine.shipengine_get_carrier_options`	Read `read`	1	Get Carrier Options Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/options.
`shipengine.shipengine_list_carrier_package_types`	Read `read`	1	List Carrier Package Types Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/packages.
`shipengine.shipengine_list_carrier_services`	Read `read`	1	List Carrier Services Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/services.
`shipengine.shipengine_connect_carrier`	Read `read`	2	Connect a carrier account Official ShipEngine endpoint: POST /v1/connections/carriers/{carrier_name}.
`shipengine.shipengine_disconnect_carrier`	Read `read`	2	Disconnect a carrier Official ShipEngine endpoint: DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}.
`shipengine.shipengine_get_carrier_settings`	Read `read`	2	Get carrier settings Official ShipEngine endpoint: GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.
`shipengine.shipengine_update_carrier_settings`	Write `write`	3	Update carrier settings Official ShipEngine endpoint: PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.
`shipengine.shipengine_disconnect_insurer`	Read `read`	0	Disconnect a Shipsurance Account Official ShipEngine endpoint: DELETE /v1/connections/insurance/shipsurance.
`shipengine.shipengine_connect_insurer`	Read `read`	1	Connect a Shipsurance Account Official ShipEngine endpoint: POST /v1/connections/insurance/shipsurance.
`shipengine.shipengine_create_combined_label_document`	Write `write`	1	Created Combined Label Document Official ShipEngine endpoint: POST /v1/documents/combined_labels.
`shipengine.shipengine_download_file`	Read `read`	5	Download File Official ShipEngine endpoint: GET /v1/downloads/{dir}/{subdir}/{filename}.
`shipengine.shipengine_list_webhooks`	Read `read`	0	List Webhooks Official ShipEngine endpoint: GET /v1/environment/webhooks.
`shipengine.shipengine_create_webhook`	Write `write`	1	Create a Webhook Official ShipEngine endpoint: POST /v1/environment/webhooks.
`shipengine.shipengine_get_webhook_by_id`	Read `read`	1	Get Webhook By ID Official ShipEngine endpoint: GET /v1/environment/webhooks/{webhook_id}.
`shipengine.shipengine_update_webhook`	Write `write`	2	Update a Webhook Official ShipEngine endpoint: PUT /v1/environment/webhooks/{webhook_id}.
`shipengine.shipengine_delete_webhook`	Write `write`	1	Delete Webhook By ID Official ShipEngine endpoint: DELETE /v1/environment/webhooks/{webhook_id}.
`shipengine.shipengine_add_funds_to_insurance`	Write `write`	1	Add Funds To Insurance Official ShipEngine endpoint: PATCH /v1/insurance/shipsurance/add_funds.
`shipengine.shipengine_get_insurance_balance`	Read `read`	0	Get Insurance Funds Balance Official ShipEngine endpoint: GET /v1/insurance/shipsurance/balance.
`shipengine.shipengine_list_labels`	Read `read`	15	List labels Official ShipEngine endpoint: GET /v1/labels.
`shipengine.shipengine_create_label`	Write `write`	1	Purchase Label Official ShipEngine endpoint: POST /v1/labels.
`shipengine.shipengine_get_label_by_external_shipment_id`	Read `read`	2	Get Label By External Shipment ID Official ShipEngine endpoint: GET /v1/labels/external_shipment_id/{external_shipment_id}.
`shipengine.shipengine_create_label_from_rate`	Write `write`	2	Purchase Label with Rate ID Official ShipEngine endpoint: POST /v1/labels/rates/{rate_id}.
`shipengine.shipengine_create_label_from_rate_shopper`	Write `write`	2	Purchase Label from Rate Shopper Official ShipEngine endpoint: POST /v1/labels/rate_shopper_id/{rate_shopper_id}.
`shipengine.shipengine_create_label_from_shipment`	Write `write`	2	Purchase Label with Shipment ID Official ShipEngine endpoint: POST /v1/labels/shipment/{shipment_id}.
`shipengine.shipengine_get_label_by_id`	Read `read`	2	Get Label By ID Official ShipEngine endpoint: GET /v1/labels/{label_id}.
`shipengine.shipengine_create_return_label`	Write `write`	2	Create a return label Official ShipEngine endpoint: POST /v1/labels/{label_id}/return.
`shipengine.shipengine_get_tracking_log_from_label`	Read `read`	1	Get Label Tracking Information Official ShipEngine endpoint: GET /v1/labels/{label_id}/track.
`shipengine.shipengine_void_label`	Read `read`	1	Void a Label By ID Official ShipEngine endpoint: PUT /v1/labels/{label_id}/void.
`shipengine.shipengine_cancel_label_refund`	Write `write`	1	Cancel a label refund request Official ShipEngine endpoint: POST /v1/labels/{label_id}/cancel_refund.
`shipengine.shipengine_list_manifests`	Read `read`	9	List Manifests Official ShipEngine endpoint: GET /v1/manifests.
`shipengine.shipengine_create_manifest`	Write `write`	1	Create Manifest Official ShipEngine endpoint: POST /v1/manifests.
`shipengine.shipengine_get_manifest_by_id`	Read `read`	1	Get Manifest By Id Official ShipEngine endpoint: GET /v1/manifests/{manifest_id}.
`shipengine.shipengine_get_manifest_request_by_id`	Read `read`	1	Get Manifest Request By Id Official ShipEngine endpoint: GET /v1/manifests/requests/{manifest_request_id}.
`shipengine.shipengine_list_package_types`	Read `read`	0	List Custom Package Types Official ShipEngine endpoint: GET /v1/packages.
`shipengine.shipengine_create_package_type`	Write `write`	1	Create Custom Package Type Official ShipEngine endpoint: POST /v1/packages.
`shipengine.shipengine_get_package_type_by_id`	Read `read`	1	Get Custom Package Type By ID Official ShipEngine endpoint: GET /v1/packages/{package_id}.
`shipengine.shipengine_update_package_type`	Write `write`	2	Update Custom Package Type By ID Official ShipEngine endpoint: PUT /v1/packages/{package_id}.
`shipengine.shipengine_delete_package_type`	Write `write`	1	Delete A Custom Package By ID Official ShipEngine endpoint: DELETE /v1/packages/{package_id}.
`shipengine.shipengine_list_scheduled_pickups`	Read `read`	6	List Scheduled Pickups Official ShipEngine endpoint: GET /v1/pickups.
`shipengine.shipengine_schedule_pickup`	Read `read`	1	Schedule a Pickup Official ShipEngine endpoint: POST /v1/pickups.
`shipengine.shipengine_get_pickup_by_id`	Read `read`	1	Get Pickup By ID Official ShipEngine endpoint: GET /v1/pickups/{pickup_id}.
`shipengine.shipengine_delete_scheduled_pickup`	Write `write`	1	Delete a Scheduled Pickup Official ShipEngine endpoint: DELETE /v1/pickups/{pickup_id}.
`shipengine.shipengine_calculate_rates`	Read `read`	1	Get Shipping Rates Official ShipEngine endpoint: POST /v1/rates.
`shipengine.shipengine_compare_bulk_rates`	Read `read`	1	Get Bulk Rates Official ShipEngine endpoint: POST /v1/rates/bulk.
`shipengine.shipengine_estimate_rates`	Read `read`	1	Estimate Rates Official ShipEngine endpoint: POST /v1/rates/estimate.
`shipengine.shipengine_get_rate_by_id`	Read `read`	1	Get Rate By ID Official ShipEngine endpoint: GET /v1/rates/{rate_id}.
`shipengine.shipengine_service_points_list`	Read `read`	1	List Service Points Official ShipEngine endpoint: POST /v1/service_points/list.
`shipengine.shipengine_service_points_get_by_id`	Read `read`	3	Get Service Point By ID Official ShipEngine endpoint: GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}.
`shipengine.shipengine_list_shipments`	Read `read`	12	List Shipments Official ShipEngine endpoint: GET /v1/shipments.
`shipengine.shipengine_create_shipments`	Write `write`	1	Create Shipments Official ShipEngine endpoint: POST /v1/shipments.
`shipengine.shipengine_get_shipment_by_external_id`	Read `read`	1	Get Shipment By External ID Official ShipEngine endpoint: GET /v1/shipments/external_shipment_id/{external_shipment_id}.
`shipengine.shipengine_parse_shipment`	Read `read`	1	Parse shipping info Official ShipEngine endpoint: PUT /v1/shipments/recognize.
`shipengine.shipengine_get_shipment_by_id`	Read `read`	1	Get Shipment By ID Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}.
`shipengine.shipengine_update_shipment`	Write `write`	2	Update Shipment By ID Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}.
`shipengine.shipengine_cancel_shipments`	Write `write`	1	Cancel a Shipment Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}/cancel.
`shipengine.shipengine_list_shipment_rates`	Read `read`	2	Get Shipment Rates Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/rates.
`shipengine.shipengine_shipments_update_tags`	Write `write`	1	Update Shipments Tags Official ShipEngine endpoint: PUT /v1/shipments/tags.
`shipengine.shipengine_shipments_list_tags`	Read `read`	1	Get Shipment Tags Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/tags.
`shipengine.shipengine_tag_shipment`	Read `read`	2	Add Tag to Shipment Official ShipEngine endpoint: POST /v1/shipments/{shipment_id}/tags/{tag_name}.
`shipengine.shipengine_untag_shipment`	Read `read`	2	Remove Tag from Shipment Official ShipEngine endpoint: DELETE /v1/shipments/{shipment_id}/tags/{tag_name}.
`shipengine.shipengine_list_tags`	Read `read`	0	Get Tags Official ShipEngine endpoint: GET /v1/tags.
`shipengine.shipengine_create_tag`	Write `write`	1	Create a New Tag Official ShipEngine endpoint: POST /v1/tags.
`shipengine.shipengine_create_tag_2`	Write `write`	1	Create a New Tag Official ShipEngine endpoint: POST /v1/tags/{tag_name}.
`shipengine.shipengine_delete_tag`	Write `write`	1	Delete Tag Official ShipEngine endpoint: DELETE /v1/tags/{tag_name}.
`shipengine.shipengine_rename_tag`	Read `read`	2	Update Tag Name Official ShipEngine endpoint: PUT /v1/tags/{tag_name}/{new_tag_name}.
`shipengine.shipengine_tokens_get_ephemeral_token`	Read `read`	1	Get Ephemeral Token Official ShipEngine endpoint: POST /v1/tokens/ephemeral.
`shipengine.shipengine_get_tracking_log`	Read `read`	3	Get Tracking Information Official ShipEngine endpoint: GET /v1/tracking.
`shipengine.shipengine_start_tracking`	Read `read`	3	Start Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/start.
`shipengine.shipengine_stop_tracking`	Read `read`	3	Stop Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/stop.
`shipengine.shipengine_list_warehouses`	Read `read`	0	List Warehouses Official ShipEngine endpoint: GET /v1/warehouses.
`shipengine.shipengine_create_warehouse`	Write `write`	1	Create Warehouse Official ShipEngine endpoint: POST /v1/warehouses.
`shipengine.shipengine_get_warehouse_by_id`	Read `read`	1	Get Warehouse By Id Official ShipEngine endpoint: GET /v1/warehouses/{warehouse_id}.
`shipengine.shipengine_update_warehouse`	Write `write`	2	Update Warehouse By Id Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}.
`shipengine.shipengine_delete_warehouse`	Write `write`	1	Delete Warehouse By ID Official ShipEngine endpoint: DELETE /v1/warehouses/{warehouse_id}.
`shipengine.shipengine_update_warehouse_settings`	Write `write`	2	Update Warehouse Settings Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}/settings.