Skip to content

Make get_started more generic #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Shopify Dev MCP Server

This project implements a Model Context Protocol (MCP) server that interacts with Shopify Dev. This protocol supports various tools to interact with different Shopify APIs.
This project implements a Model Context Protocol (MCP) server that interacts with Shopify Dev. This protocol supports various tools to interact with different Shopify APIs. At the moment the following APIs are supported:

- Admin GraphQL API
- Functions
- (Optional) Polaris Web Components

## Setup

Expand Down Expand Up @@ -38,14 +42,34 @@ On Windows, you might need to use this alternative configuration:
}
```

### Opt-in Polaris support (experimental)

If you want Cursor or Claude Desktop to surface Polaris Web Components documentation, include an `env` block with the `POLARIS_UNIFIED` flag in your MCP server configuration:

```json
{
"mcpServers": {
"shopify-dev-mcp": {
"command": "npx",
"args": ["-y", "@shopify/dev-mcp@latest"],
"env": {
"POLARIS_UNIFIED": "true"
}
}
}
}
```

## Available tools

This MCP server provides the following tools:

| Tool Name | Description |
| ----------------------- | ---------------------------------------------- |
| search_dev_docs | Search shopify.dev documentation |
| introspect_admin_schema | Access and search Shopify Admin GraphQL schema |
| Tool Name | Description |
| ----------------------- | ------------------------------------------------------ |
| search_dev_docs | Search shopify.dev documentation |
| introspect_admin_schema | Access and search Shopify Admin GraphQL schema |
| fetch_docs_by_path | Retrieve documents from shopify.dev |
| get_started | Get started with Shopify APIs (Admin, Functions, etc.) |

## Available prompts

Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ async function main() {
);

// Register Shopify tools
shopifyTools(server);
await shopifyTools(server);

// Register Shopify prompts
shopifyPrompts(server);
Expand Down
Loading