Registry / llm-agents / polaris-mcp-server

polaris-mcp-server

JSON →
library1.0.0jsnpmunverified

A Model Context Protocol (MCP) server that provides tools and prompts for working with Shopify Polaris UI components. Version 1.0.0 enables AI assistants to search components, get detailed props and best practices, and retrieve code examples. It supports Node.js >=14.17.0 and is designed for Cursor or Claude Desktop integration. Key differentiators: specialized prompts for component implementation and layout design, and direct access to Polaris component data without manual documentation lookups.

npm install polaris-mcp-server
INSTALL
IMPORT
SIG · POLARIS-MCP-SERVER
P
polaris-mcp-server
llm-agentsjavascriptv1.0.0
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Server
import { Server } from '@modelcontextprotocol/sdk/server/index.js'
ESM-only. SDK version must be compatible with MCP protocol.
StdioServerTransport
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
import { StdioServerTransport } from '@modelcontextprotocol/sdk'
Exported from subpath 'server/stdio.js', not root.
CallToolRequestSchema
import { CallToolRequestSchema } from '@modelcontextprotocol/sdk/types.js'
Type schema for tool requests.

Configures the MCP client to use polaris-mcp-server and demonstrates calling the three available tools: search, details, examples.

// Add to MCP client config (e.g., Cursor or Claude Desktop): // { // "mcpServers": { // "polaris-mcp-server": { // "command": "npx", // "args": ["-y", "polaris-mcp-server@latest"] // } // } // } // Then use in your AI assistant: // Search for components const result = await use_mcp_tool('polaris-mcp-server', 'search_polaris_components', { query: 'button', category: 'Actions' }); // Get details const details = await use_mcp_tool('polaris-mcp-server', 'get_component_details', { componentName: 'Button' }); // Get examples const examples = await use_mcp_tool('polaris-mcp-server', 'get_component_examples', { componentName: 'Button' });
Debug
Known issues
gotchaWindows users must use 'cmd /k npx -y polaris-mcp-server' instead of direct npx command.
fix
Use the alternative Windows config: { command: 'cmd', args: ['/k', 'npx', '-y', 'polaris-mcp-server'] }
affects: >=1.0.0
deprecatedThe 'get_component_examples' tool may return stale examples if the data folder is not refreshed.
fix
Re-run 'npm run scrape' to update component data.
affects: >=1.0.0
gotchaComponent data is pre-scraped and bundled; it may not reflect the latest Polaris documentation.
fix
Re-generate the data by running the scraper script periodically.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module '@modelcontextprotocol/sdk'
Missing dependency when running via npx without installing locally.
fix
Ensure npx fetches the package correctly; if using local install, run 'npm install @modelcontextprotocol/sdk'.
Error: listen EADDRINUSE :::0
Another instance of the MCP server is already running using the same transport.
fix
Kill the previous process or use a different transport (e.g., change port if using SSE).
Tool not found: search_polaris_components
Client is connecting to a different MCP server or the server failed to register tools.
fix
Check server logs for startup errors. Ensure client configuration points to the correct server name.
Upgrade
Version history
1.0.0latest on npm
Audit
Dependencies
@modelcontextprotocol/sdkrequiredCore SDK for implementing MCP server
Agent activity
25 hits · last 30 days
node
22
OpenAI (training)
1
Resources
polaris-mcp-server — npm install polaris-mcp-server · libregistry