https://github.com/shopify/dev-mcp
Shopify.dev MCP server
https://github.com/shopify/dev-mcp
Last synced: 7 months ago
JSON representation
Shopify.dev MCP server
- Host: GitHub
- URL: https://github.com/shopify/dev-mcp
- Owner: Shopify
- License: isc
- Created: 2025-03-11T17:12:17.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T12:55:08.000Z (8 months ago)
- Last Synced: 2025-04-02T22:40:01.729Z (7 months ago)
- Language: TypeScript
- Size: 3.2 MB
- Stars: 70
- Watchers: 60
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- toolsdk-mcp-registry - ✅ @shopify/dev-mcp
README
# 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.
## Setup
To run the Shopify MCP server using npx, use the following command:
```bash
npx -y @shopify/dev-mcp@latest
```
## Usage with Cursor or Claude Desktop
Add the following configuration. For more information, read the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol) or the [Claude Desktop MCP guide](https://modelcontextprotocol.io/quickstart/user).
```json
{
"mcpServers": {
"shopify-dev-mcp": {
"command": "npx",
"args": ["-y", "@shopify/dev-mcp@latest"]
}
}
}
```
On Windows, you might need to use this alternative configuration:
```json
{
"mcpServers": {
"shopify-dev-mcp": {
"command": "cmd",
"args": ["/k", "npx", "-y", "@shopify/dev-mcp@latest"]
}
}
}
```
## 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 |
## Available prompts
This MCP server provides the following prompts:
| Prompt Name | Description |
| --------------------- | ----------------------------------------------------------- |
| shopify_admin_graphql | Help you write GraphQL operations for the Shopify Admin API |
## Development
The server is built using the MCP SDK and communicates with Shopify Dev.
1. `npm install`
1. Modify source files
1. Run `npm run build` to compile
1. Run `npm run test` to run tests
1. Add an MCP server that runs this command: `node /dist/index.js`
## License
ISC