@baseline-ui/mcp 0.0.0-nightly-20251125000500 → 0.0.0-nightly-20251202000557

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # @baseline-ui/mcp
 
-## 0.0.0-nightly-20251125000500
+## 0.0.0-nightly-20251202000557
+
+## 0.47.0
+
+### Patch Changes
+
+- a75ad6f: Added resource with guidelines for Baseline UI
 
 ## 0.46.2
 

package/dist/guidelines.md

@@ -0,0 +1,88 @@
+# Baseline UI MCP Server Guidelines
+
+This MCP server provides AI assistants with access to Baseline UI's component documentation, icons, and design resources.
+
+- Baseline UI is a design system for building accessible and consistent user interfaces.
+- It is built with React and TypeScript and styled with Vanilla Extract.
+- It is also known as BUI.
+- It is a client side design system that depends on global variables like document, window, etc.
+
+## Available Tools
+
+### Component Documentation
+
+**`list_baseline_components`**
+
+- Lists all available components in the Baseline UI design system
+- Optional parameter: `includeDescription` (boolean) - includes component descriptions
+- Use this when you need to discover what components are available
+
+**`get_baseline_component_info`**
+
+- Returns high-level component information: name, description, and available documentation sections
+- Requires: `componentName` (string)
+- Use this before diving into detailed documentation to understand what sections are available
+
+**`get_baseline_component_docs`**
+
+- Returns complete or section-specific component documentation in markdown format
+- Requires: `componentName` (string)
+- Optional: `sectionName` (string) - get a specific section (e.g., "Usage", "Examples")
+- Use this to read component documentation, examples, and usage patterns
+
+**`get_baseline_component_types`**
+
+- Returns TypeScript type definitions and prop interfaces for a component
+- Requires: `componentName` (string)
+- Use this when you need to understand component props, their types, and constraints
+
+**`get_baseline_component_source`**
+
+- Returns the source code implementation of a component
+- Requires: `componentName` (string)
+- Use this to understand how a component is implemented
+
+### Icon System
+
+**`search_baseline_icons`**
+
+- Searches the Baseline UI icon set by name
+- Requires: `terms` (string or array of strings)
+- Returns icon names matching the search terms
+- Import syntax: `import { IconName } from '@baseline-ui/icons/[size]'`
+
+### Getting Started
+
+**`get_baseline_getting_started`**
+
+- Returns complete setup and installation guide for Baseline UI
+- Use this when helping users set up Baseline UI in a new project
+- Always use this for setup-related questions or issues
+
+## Recommended Workflow
+
+1. **For component discovery**: Use `list_baseline_components` to see available components
+2. **For understanding a component**: Use `get_baseline_component_info` to see available sections
+3. **For detailed documentation**: Use `get_baseline_component_docs` to read full documentation or specific sections
+4. **For implementation details**: Use `get_baseline_component_types` and `get_baseline_component_source`
+5. **For icon selection**: Use `search_baseline_icons` with relevant terms
+6. **For setup**: Use `get_baseline_getting_started` for new projects or setup issues
+
+## Styling Guidelines
+
+When recommending styling or customization approaches:
+
+- **Always prioritize using sprinkles from `@baseline-ui/tokens`** for styling
+- Sprinkles provides a type-safe, zero-runtime CSS utility layer built with Vanilla Extract
+- Use sprinkles for spacing, colors, typography, shadows, and other design tokens
+- Example: `<div className={sprinkles({ padding: 'md', color: 'text.primary' })}>Content</div>`
+- Only use custom CSS when sprinkles doesn't provide the necessary utilities
+- This ensures consistency with the design system and maintains design token governance
+
+## Tips for Better Results
+
+- When presenting component information to users, format tool results as readable lists or tables, not raw JSON
+- For component documentation, render markdown content with proper formatting and syntax highlighting
+- When suggesting components, mention available sections that users can explore
+- For props and types, highlight required vs optional properties and their constraints
+- When searching icons, try multiple terms if the first search doesn't yield results (e.g., "search", "find", "magnifying")

package/dist/index.js

@@ -164,6 +164,26 @@ async function startServer() {
         name: "baseline-ui-docs-server",
         version: packageJson.version,
     });
+    // Register guidelines resource
+    server.registerResource("guidelines", "resource://baseline-ui/guidelines.md", {
+        description: "Guidelines for using the Baseline UI MCP server",
+        mimeType: "text/markdown",
+    }, () => {
+        const guidelinesPath = path.resolve(__dirname, "guidelines.md");
+        if (!fs.existsSync(guidelinesPath)) {
+            throw new Error("Guidelines file not found");
+        }
+        const content = fs.readFileSync(guidelinesPath, "utf8");
+        return {
+            contents: [
+                {
+                    uri: "resource://baseline-ui/guidelines.md",
+                    mimeType: "text/markdown",
+                    text: content,
+                },
+            ],
+        };
+    });
     // List components tool
     server.registerTool("list_baseline_components", {
         title: "List Baseline UI components",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baseline-ui/mcp",
-  "version": "0.0.0-nightly-20251125000500",
+  "version": "0.0.0-nightly-20251202000557",
   "description": "MCP server for Baseline UI design system documentation",
   "type": "module",
   "bin": "dist/index.js",