@splunk/splunk-ui-mcp
v0.5.0
Published
Model Context Protocol server for the Splunk UI Design System
Readme
@splunk/splunk-ui-mcp
A Model Context Protocol (MCP) server that gives AI assistants Splunk UI Design System documentation, including:
- Version requirements for building with Splunk UI packages
- Component documentation and usage guidance
- Design pattern best practices
- Icon search and metadata
Requirements
- Node.js 22 or newer
- An MCP-compatible client (VS Code, Cursor, Windsurf, Claude Desktop, Goose, etc.)
- Access to @splunk/react-ui, @splunk/react-icons, and @splunk/themes
Install and configure
Option 1: Tool-specific commands
CLI
# Claude CLI
claude mcp add splunk-ui -- npx @splunk/splunk-ui-mcp@latest
# Codex
codex mcp add splunk-ui -- npx @splunk/splunk-ui-mcp@latestInstall Links (copy and paste these URLs into your browser):
# VS Code
vscode:mcp/install?%7B%22name%22%3A%22splunk-ui%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40splunk/splunk-ui-mcp%40latest%22%5D%7D
# Cursor:
cursor://anysphere.cursor-deeplink/mcp/install?name=splunk-ui&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJAc3BsdW5rL3NwbHVuay11aS1tY3BAbGF0ZXN0Il19Option 2: Manual npx configuration (universal)
Use npx in your MCP client configuration (works in most tools):
{
"mcpServers": {
"splunk-ui": {
"command": "npx",
"args": ["@splunk/splunk-ui-mcp@latest"]
}
}
}To pin a version, replace @latest with the desired version.
Reference
If you need the underlying tool, resource, or prompt names (for debugging or client integrations), use the list below.
Tools
find_component: Find@splunk/react-uicomponents by exact name or fuzzy query; returns full docs for exact matches and suggestions otherwise.find_icon: Search@splunk/react-iconsand return a recommended icon plus alternatives.find_design_token: Search@splunk/themesdesign tokens and return recommended matches.list_splunk_ui_requirements: Return version requirements and peer dependencies.
Resources
Component documentation
mcp://splunk-ui/components/{componentName}Icon catalog
mcp://splunk-ui/icons/{iconName}Design tokens
mcp://splunk-ui/design-tokens/{tokenName}Prompts
audit_code: Audit code against Splunk UI Design System guidelines.build_ui: Implement a Figma design or text description using Splunk UI components.create_scaffold: Scaffold new Splunk UI standalone apps.session_feedback: Generate quality feedback report on MCP tools, prompts, and resources.
Troubleshooting
- Ensure Node.js 22+ is installed and available in your PATH
No server info founderror: This usually means an older Node.js version
- Try running
npx @splunk/splunk-ui-mcp@latest --versionto test connectivity - Restart your development tool after adding the configuration
