Skip to content

Commit fd0b9f3

Browse files
committed
docs: update README with container usage and new features
- Add Quick Start guide using ghcr.io Container image - Document new list_organization_skills tool - Add instructions for running in HTTP/SSE mode
1 parent 9b48960 commit fd0b9f3

File tree

1 file changed

+58
-20
lines changed

1 file changed

+58
-20
lines changed

README.md

Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,61 @@
11
# Agileday MCP Server
22

3-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
44
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
5-
[![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](https://www.docker.com/)
5+
[![Docker](https://img.shields.io/badge/docker-ghcr.io-blue.svg)](https://github.com/eficode/mcp-agileday/pkgs/container/mcp-agileday)
66

7-
A [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol) server for **Agileday**.
7+
A Model Context Protocol (MCP) server for Agileday.
88

9-
This server bridges Agileday's competence and employee data with LLMs (like Claude Desktop). It allows you to ask natural language questions about your organization's skills, finding experts, and viewing competence profiles without leaving your chat interface.
9+
This server bridges Agileday's competence and employee data with LLMs (like Claude Desktop or Cursor). It allows you to ask natural language questions about your organization's skills, find experts, and explore competence profiles.
1010

1111
## Capabilities
1212

1313
This server implements the following tools:
1414

15-
* **`find_experts_with_skill`**: Search for employees who possess a specific skill or competence (e.g., "Who knows React?").
16-
* **`get_employee_competence_profile`**: Retrieve a full list of skills and proficiency levels for a specific employee.
17-
18-
## Prerequisites
19-
20-
* **Agileday Account:** You need an active Agileday workspace.
21-
* **API Token:** An API Bearer token from Agileday.
22-
* **Tenant ID:** Your company slug (e.g., if your URL is `acme.agileday.io`, your tenant ID is `acme`).
23-
* **MCP Client:** An application that supports MCP, such as [Claude Desktop](https://claude.ai/download).
15+
* **find_experts_with_skill**
16+
* *Query:* "Who knows React?"
17+
* *Action:* Searches for employees who possess a specific skill and returns their proficiency levels.
18+
* **get_employee_competence_profile**
19+
* *Query:* "What are Jane Doe's top skills?"
20+
* *Action:* Retrieves a full list of skills, proficiency levels, and motivation for a specific employee.
21+
* **list_organization_skills**
22+
* *Query:* "What skills do we have in the organization?"
23+
* *Action:* Retrieves the full taxonomy of skills available in your Agileday workspace, grouped by category. This helps the AI understand exactly which terms to search for and avoids guessing.
2424

2525
## Configuration
2626

27-
The server requires the following environment variables:
27+
You need the following environment variables to run the server:
2828

2929
| Variable | Description | Example |
3030
| :--- | :--- | :--- |
31-
| `AGILEDAY_TENANT_ID` | Your specific Agileday subdomain. | `acme` |
31+
| `AGILEDAY_TENANT_ID` | Your company slug (subdomain). | `acme` (for `acme.agileday.io`) |
3232
| `AGILEDAY_API_TOKEN` | Your API Bearer token. | `eyJhbGciOi...` |
3333

34-
## Installation & Usage
35-
36-
You can run this server using Docker (recommended) or directly with Python.
34+
## Quick Start (Docker)
35+
36+
The easiest way to run the server is using the pre-built Docker image from the GitHub Container Registry.
37+
38+
### 1. Run with Claude Desktop
39+
Add this configuration to your `claude_desktop_config.json`:
40+
41+
```json
42+
{
43+
"mcpServers": {
44+
"agileday": {
45+
"command": "docker",
46+
"args": [
47+
"run",
48+
"-i",
49+
"--rm",
50+
"-e", "AGILEDAY_TENANT_ID=your_tenant_id",
51+
"-e", "AGILEDAY_API_TOKEN=your_api_token",
52+
"ghcr.io/eficode/mcp-agileday:latest"
53+
]
54+
}
55+
}
56+
}
3757

38-
### Option 1: Docker (Recommended)
58+
### Option 2: Docker
3959

4060
1. **Clone the repository:**
4161
```bash
@@ -71,7 +91,7 @@ You can run this server using Docker (recommended) or directly with Python.
7191

7292
4. **Restart Claude Desktop.**
7393

74-
### Option 2: Local Python
94+
### Option 3: Local Python
7595

7696
1. **Clone the repository and install dependencies:**
7797
```bash
@@ -97,6 +117,24 @@ You can run this server using Docker (recommended) or directly with Python.
97117
}
98118
}
99119
```
120+
121+
### Option 4: Run as service
122+
To deploy this as a standalone service (e.g., for remote access or clients that support HTTP transport), use the http transport mode.
123+
124+
```bash
125+
docker run -d \
126+
-p 8000:8000 \
127+
-e AGILEDAY_TENANT_ID=your_tenant \
128+
-e AGILEDAY_API_TOKEN=your_token \
129+
ghcr.io/eficode/mcp-agileday:latest \
130+
--transport http
131+
```
132+
133+
The server will be available at:
134+
135+
Universal Endpoint: http://localhost:8000/mcp (Supports both SSE stream and POST messages)
136+
137+
Health Check: http://localhost:8000/health
100138

101139
## Example Prompts
102140

0 commit comments

Comments
 (0)