ids-enterprise-mcp-server/README.md

Model Context Protocol (MCP) server providing comprehensive IDS Enterprise Web Components documentation access via GitLab API. Use with npx and GitLab token for instant access.

# IDS Enterprise Web Components MCP Server

A Model Context Protocol (MCP) server that provides comprehensive access to IDS Enterprise Web Components documentation, enabling AI assistants to search and retrieve component information, examples, and development guidelines.

## 🚀 Quick Start

### Prerequisites
- Node.js 18+ installed
- GitLab access to https://oxford.awsdev.infor.com

### 1. Get Your GitLab Token
1. Visit: https://oxford.awsdev.infor.com/-/user_settings/personal_access_tokens
2. Click "Add new token"
3. Configure:
   - **Name**: `IDS-WC-MCP-Server`
   - **Scopes**: Select `read_api` and `read_repository`
4. Copy the generated token

### 2. Add to Your AI Assistant

**Amazon Q CLI**:
```json
{
  "mcpServers": {
    "ids-enterprise-wc": {
      "command": "npx",
      "args": ["ids-enterprise-mcp-server", "--token=YOUR_GITLAB_TOKEN_HERE"]
    }
  }
}
```

### 3. Start Using
Once configured, ask your AI assistant questions like:
- "Search for button components with icons"
- "Show me Angular examples for ids-data-grid"
- "List all Form Input Components"
- "How do I implement ids-modal in Angular?"

## 📋 Available Tools

The server provides 11 tools organized by purpose:

### Project Discovery
- **`get_project_overview`** - Get overview of IDS Enterprise Web Components
- **`list_all_categories`** - List component categories with counts
- **`list_frameworks`** - List supported framework integrations

### Component Discovery
- **`search_components`** - Search for components by name/feature
  - Parameters: `query` (required), `category` (optional), `limit` (optional)
- **`list_components_by_category`** - List components in a category
  - Parameters: `category` (required)
- **`get_component_details`** - Get detailed component information
  - Parameters: `component` (required)

### Implementation Examples
- **`get_component_readme_examples`** - Get basic usage examples
  - Parameters: `component` (required)
- **`get_component_framework_examples`** - Get framework-specific examples
  - Parameters: `component` (required), `framework` (required)

### Development Resources
- **`get_framework_guide`** - Get framework setup guides
  - Parameters: `framework` (required)
- **`search_documentation`** - Search general documentation
  - Parameters: `query` (required), `limit` (optional)
- **`get_development_guidelines`** - Get development best practices
  - Parameters: `topic` (optional)

### Example Usage Patterns
```
"Give me an overview of IDS Enterprise Web Components"
"Search for data grid components"
"Get details for ids-button component"
"Show me React examples for ids-modal"
"How do I set up IDS components in Angular?"
"What are the accessibility guidelines?"
```

## 🛠️ Development

### Local Development Setup

#### Step 1: Clone Repository
```bash
git clone ssh://git@oxfordssh.awsdev.infor.com:7999/infor-design/ids-enterprise-mcp-server.git
cd enterprise-wc-mcp-server
```

#### Step 2: Install & Build
```bash
# Install dependencies
npm install

# Build the project
npm run build
```

#### Step 3: Replace GitLab Token
Replace `YOUR_TOKEN` with your actual GitLab token in:

**package.json commands:**
```json
{
  "scripts": {
    "start": "node build/main.js --token=YOUR_TOKEN",
    "dev": "npm run build && node build/main.js --token=YOUR_TOKEN"
  }
}
```

**mcp-inspector-config.json:**
```bash
# Replace YOUR_TOKEN with your actual token
{
  "mcpServers": {
    "ids-enterprise-mcp-server": {
      "command": "node",
      "args": ["build/main.js", "--token=YOUR_TOKEN"],
      "cwd": "."
    }
  }
}
```

#### Step 4: Test the Server (Two Ways)

**Method 1: Web Interface Testing**
```bash
npm run test:inspector
```
This opens a web interface where you can:
- View all available tools
- Test tool calls with parameters
- See formatted responses
- Debug issues

**Method 2: Amazon Q Configuration**
Add this configuration to your Amazon Q MCP settings:
```json
{
  "mcpServers": {
    "enterprise-wc-mcp-server": {
      "command": "node",
      "args": [
        "/path/to/your/enterprise-wc-mcp-server/build/main.js"
      ],
      "env": {
        "GITLAB_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}
```

## 🔗 Resources

- **[IDS Enterprise Web Components](https://oxford.awsdev.infor.com/infor-design/enterprise-wc)** - Main repository
- **[IDS Design System](https://design.infor.com/)** - Design guidelines
- **[Model Context Protocol](https://github.com/modelcontextprotocol)** - MCP specification