Skip to main content
Glama
README.md
# AI Company MCP Server

> **AI Knowledge & Skills Server** โ€” Expose your entire AI knowledge base to any MCP client.

[![npm version](https://img.shields.io/npm/v/ai-company-mcp.svg)](https://www.npmjs.com/package/ai-company-mcp)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Node.js Version](https://img.shields.io/node/v/ai-company-mcp.svg)](https://nodejs.org)

A production-ready [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that acts as your AI knowledge and skills hub. It automatically discovers, indexes, and serves your skill library to any MCP-compatible client.

## โœจ Features

- ๐Ÿ” **Automatic Skill Discovery** โ€” Drop folders into `knowledge/skills/` and they're instantly available
- ๐Ÿš€ **Full-Text Search** โ€” TF-IDF powered search with relevance ranking and filtering
- ๐Ÿ“‹ **Rich Metadata** โ€” YAML frontmatter parsing with automatic inference
- ๐Ÿ”„ **Hot Reload** โ€” File watcher automatically reindexes on changes
- ๐Ÿ›  **17 MCP Tools** โ€” List, search, get, recommend, validate, export, and more
- ๐Ÿ“š **10 MCP Prompts** โ€” Frontend, backend, React, testing, architecture, and more
- ๐Ÿ“ฆ **MCP Resources** โ€” Browse skills, metadata, categories, tags via resource API
- โšก **High Performance** โ€” In-memory index, caching, lazy loading
- ๐ŸŒ **Cross-Platform** โ€” Windows, Linux, macOS
- ๐Ÿ”’ **Runs Locally** โ€” No network, no external services, your data stays private

## ๐Ÿš€ Quick Start

```bash
# Run directly (no installation)
npx ai-company-mcp
```

Or install globally:

```
npm install -g ai-company-mcp
ai-company-mcp
```

## ๐Ÿ“ Skill Structure

Create skill directories in `knowledge/skills/`:

```
knowledge/skills/
โ””โ”€โ”€ react-patterns/
    โ”œโ”€โ”€ SKILL.md          # Primary file
    โ””โ”€โ”€ examples.md       # Additional files
```

Each skill's markdown file supports YAML frontmatter:

```
---
name: react-patterns
description: Common React patterns and best practices
category: frontend
tags: [react, patterns, hooks]
priority: high
difficulty: intermediate
---
```

## ๐Ÿ”Œ Client Configuration

### OpenCode

```
{
  "mcp": {
    "ai-company": {
      "command": "npx",
      "args": ["-y", "ai-company-mcp"]
    }
  }
}
```

### Claude Desktop

```
{
  "mcpServers": {
    "ai-company": {
      "command": "npx",
      "args": ["-y", "ai-company-mcp"]
    }
  }
}
```

### Cursor / VS Code / Windsurf

See [`examples/`](https://./examples/) for all client configurations.

## ๐Ÿ›  Available Tools

| Tool โ†•โ–พ | Description โ†•โ–พ |
|---|---|
| โˆ’`list_skills` | List all skills with filtering |
| โˆ’`search_skills` | Full-text search with ranking |
| โˆ’`get_skill` | Get complete skill details |
| โˆ’`recommend_skills` | Find related skills |
| โˆ’`list_categories` | List all categories |
| โˆ’`list_tags` | List all tags |
| โˆ’`reload_index` | Force reindex from disk |
| โˆ’`validate_skill` | Validate skill structure |
| โˆ’`summarize_skill` | Generate skill summary |
| โˆ’`explain_skill` | Detailed skill explanation |
| โˆ’`find_related_skills` | Tag-based related skills |
| `find_best_skill` | Best match for a task |
| `export_skill` | Export in markdown/JSON/text |
| `export_index` | Export full index as JSON |
| `statistics` | Knowledge base stats |
| `health` | Server health check |
| `ping` | Connectivity check |
โš™

## โš™๏ธ Configuration

```
# Environment variables
MCP_SKILLS_PATH=./my-skills
MCP_WATCH_ENABLED=true
MCP_LOG_LEVEL=debug

# CLI arguments
npx ai-company-mcp --skills-path=./my-skills --watch=false

# JSON config file (mcp-config.json)
{
  "skillsPath": "./my-skills",
  "watchEnabled": true,
  "logLevel": "debug"
}
```

See [docs/configuration.md](https://./docs/configuration.md) for full options.

## ๐Ÿ“– Documentation

- [Usage Guide](https://./docs/usage.md)
- [Configuration](https://./docs/configuration.md)
- [Architecture](https://./docs/architecture.md)
- [Development](https://./docs/development.md)
- [Troubleshooting](https://./docs/troubleshooting.md)

## ๐Ÿงช Development

```
git clone <repo-url>
cd ai-company-mcp
npm install
npm run dev       # Hot reload development mode
npm test          # Run tests
npm run build     # Production build
```

## ๐Ÿ“„ License

MIT โ€” see [LICENSE](https://LICENSE) for details.