Skip to content
View as Markdown
View as Markdown

Documentation Tools

MCP tools for searching and reading the bundled B2C Commerce Script API documentation and XSD schemas. These tools read data shipped with the SDK — they do not require any instance configuration or authentication. Available in every toolset.

Note: docs_read and docs_schema_read content can be large (full markdown files / full XSD bodies). Prefer docs_search/docs_schema_search to narrow down before reading.


Script API

Fuzzy-search Script API documentation by class, module, or partial name.

ParameterTypeRequiredDefaultDescription
querystringYesSearch query (e.g., "ProductMgr", "dw.catalog", "Status")
limitnumberNo20Maximum number of results

Returns: {query, results: [{entry: {id, title, filePath, preview?}, score}]}. Lower score = better match.

docs_read

Read full markdown documentation for a Script API class or module.

ParameterTypeRequiredDescription
querystringYesExact id (e.g., "dw.catalog.ProductMgr") or fuzzy query

Returns: {entry: {id, title, filePath, preview?}, content: string}. Returns an error result with a hint to use docs_search if no match is found.

docs_list

List every available Script API documentation entry.

No parameters.

Returns: {count, entries: [{id, title, filePath, preview?}]}. Output is large; prefer docs_search for targeted lookups.


XSD Schemas

Fuzzy-search XSD schema ids.

ParameterTypeRequiredDefaultDescription
querystringYesSchema name or partial match (e.g., "catalog", "order")
limitnumberNo20Maximum number of results

Returns: {query, results: [{entry: {id, filePath}, score}]}.

docs_schema_read

Read the contents of an XSD schema (raw XML) plus the on-disk path.

ParameterTypeRequiredDescription
querystringYesExact id or fuzzy query

Returns: {entry: {id, filePath}, content: string, path: string}. Returns an error result with a hint to use docs_schema_search if no match.

docs_schema_list

List every available XSD schema id.

No parameters.

Returns: {count, entries: [{id, filePath}]}.


See also

Released under the Apache-2.0 License.