An open API service indexing awesome lists of open source software.

https://github.com/magebitcom/magento2-mcp-catalog-tools

Catalog tool extension for the Magebit's Magento2 MCP module
https://github.com/magebitcom/magento2-mcp-catalog-tools

adobe adobe-commerce ai magento2 magento2-extension magento2-module mcp-server

Last synced: 11 days ago
JSON representation

Catalog tool extension for the Magebit's Magento2 MCP module

Awesome Lists containing this project

README

          

# Magento2 MCP - Catalog Tools

This is a sub-module for the [Magento2 MCP module](https://github.com/magebitcom/magento2-mcp-module)

----

Catalog-domain MCP tools for `Magebit_Mcp`. Exposes catalog **products** and
**categories** — paginated reads, single-entity reads with field-resolver-driven
shape, and writes (create / update / delete) wired through Magento service
contracts.

Each tool is a thin wrapper over the corresponding Magento service contract
(`ProductRepositoryInterface`, `CategoryRepositoryInterface`,
`CategoryListInterface`, `StockRegistryInterface`,
`CategoryManagementInterface`). Read responses are composed from field
resolvers that 3rd-party modules can extend; writes go through the same
repositories the admin UI uses, so server-side validation and reindex hooks
fire identically.

## Install

```bash
composer require magebitcom/magento2-mcp-catalog-tools
bin/magento module:enable Magebit_McpCatalogTools
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

## Tool catalog

### Products (read)

| Tool | What it does |
|---|---|
| `catalog.product.list` | Paginated product search; filter by sku (exact / `*glob*` / array), name substring, status, visibility, type_id, attribute_set_id, price range, qty range, category_id, website_id, created_at range, updated_at range. |
| `catalog.product.get` | Single product by numeric id or SKU. Default response includes identity, state, pricing, tier prices, stock, categories (ids + names), websites, media gallery, links, configurable / bundle option metadata, custom attributes, and timestamps; narrow with `fields` / `exclude`. |

### Categories (read)

| Tool | What it does |
|---|---|
| `catalog.category.list` | Paginated category search; filter by name substring, is_active, include_in_menu, parent_id, level range. |
| `catalog.category.get` | Single category by numeric id; tree metadata, content, meta, state, plus the product ids assigned to the category (drop with `exclude: ["products"]`). |

### Products (write)

Write tools require the global `magebit_mcp/general/allow_writes` flag **and**
the token's own `allow_writes` flag to be `1`. All writes require explicit
confirmation so MCP clients prompt before firing.

| Tool | Confirm? | What it does |
|---|---|---|
| `catalog.product.create` | yes | Create a product. Required: sku, name, price, attribute_set_id, type_id, status, visibility (plus weight for physical types). Accepts top-level scalars (description, url_key, tax_class_id, meta_*) plus `custom_attributes`, `website_ids`, `category_ids`. |
| `catalog.product.update` | yes | PATCH-style update by id or sku; only fields you provide are touched. Use `new_sku` to rename. |
| `catalog.product.delete` | yes | Permanently delete a product. |

### Categories (write)

| Tool | Confirm? | What it does |
|---|---|---|
| `catalog.category.create` | yes | Create a category under an existing parent. |
| `catalog.category.update` | yes | PATCH-style update by id. Changing `parent_id` triggers a tree move via `CategoryManagementInterface::move()` (path / level rebuild); use `after_id` to control sibling ordering at the destination. |
| `catalog.category.delete` | yes | Permanently delete a category and its descendants. Cascades. |

Every write tool also implements `Magebit\Mcp\Api\UnderlyingAclAwareInterface`
with `Magento_Catalog::products` / `Magento_Catalog::categories` as the
underlying Magento admin resource, so they block calls from admins who
wouldn't be allowed to perform the same action in the admin UI.

## Extending

See `docs/EXTENDING.md` for:
- adding a new field to any tool response via `ProductFieldResolverInterface`
/ `CategoryFieldResolverInterface`;
- adding a new filter to `catalog.product.list` / `catalog.category.list`
via `ProductFilterTranslatorInterface` /
`CategoryFilterTranslatorInterface`;
- the ACL layering rules for custom write tools.

## License

Released under the [MIT License](LICENSE).

---

![magebit (1)](https://github.com/user-attachments/assets/cdc904ce-e839-40a0-a86f-792f7ab7961f)

*Have questions or need help? Contact us at info@magebit.com*