outline-mcp-server 4.2.0 → 4.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -22
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -5,20 +5,21 @@ A Model Context Protocol (MCP) server that provides tools for interacting with O
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- **Document Management**
|
|
8
|
-
- Create new documents with customizable properties
|
|
9
|
-
- Get document details
|
|
10
|
-
- Update existing documents
|
|
11
|
-
- Delete documents
|
|
12
|
-
- List documents
|
|
8
|
+
- ✅ Create new documents with customizable properties
|
|
9
|
+
- ✅ Get document details
|
|
10
|
+
- ✅ Update existing documents
|
|
11
|
+
- ✅ Delete documents
|
|
12
|
+
- ✅ List documents
|
|
13
|
+
- ✅ Search documents
|
|
13
14
|
|
|
14
15
|
- **Collection Management**
|
|
15
|
-
- Get collection details
|
|
16
|
-
- List collections
|
|
17
|
-
- Create and update collections
|
|
16
|
+
- ✅ Get collection details
|
|
17
|
+
- ✅ List collections
|
|
18
|
+
- ✅ Create and update collections
|
|
18
19
|
|
|
19
20
|
- **Team Management**
|
|
20
|
-
- List teams/groups
|
|
21
|
-
- Get team/group details
|
|
21
|
+
- ✅ List teams/groups
|
|
22
|
+
- ✅ Get team/group details
|
|
22
23
|
|
|
23
24
|
## Prerequisites
|
|
24
25
|
|
|
@@ -31,21 +32,17 @@ A Model Context Protocol (MCP) server that provides tools for interacting with O
|
|
|
31
32
|
### Installation
|
|
32
33
|
|
|
33
34
|
```bash
|
|
34
|
-
#
|
|
35
|
-
|
|
35
|
+
# Run directly with npx
|
|
36
|
+
OUTLINE_API_KEY=… npx outline-mcp-server
|
|
36
37
|
|
|
37
|
-
#
|
|
38
|
-
|
|
38
|
+
# or install from npm
|
|
39
|
+
npm install -g outline-mcp-server
|
|
40
|
+
OUTLINE_API_KEY=… outline-mcp-server
|
|
39
41
|
```
|
|
40
42
|
|
|
41
|
-
###
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
OUTLINE_API_KEY=your_outline_api_key_here
|
|
47
|
-
OUTLINE_BASE_URL=https://your-outline-instance.com/api # Optional, defaults to https://app.getoutline.com/api
|
|
48
|
-
```
|
|
43
|
+
### Env
|
|
44
|
+
- `OUTLINE_API_KEY` (*required*): your API key for outline, duh
|
|
45
|
+
- `OUTLINE_BASE_URL` (*optional*): Alternative URL for your outline API (if using an alt domain/self-hosting)
|
|
49
46
|
|
|
50
47
|
### Usage
|
|
51
48
|
|
|
@@ -67,7 +64,16 @@ cd outline-mcp
|
|
|
67
64
|
|
|
68
65
|
# Install dependencies
|
|
69
66
|
npm install
|
|
67
|
+
```
|
|
70
68
|
|
|
69
|
+
### Create a `.env` file with your Outline API key:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
OUTLINE_API_KEY=your_outline_api_key_here
|
|
73
|
+
OUTLINE_BASE_URL=https://your-outline-instance.com/api # Optional, defaults to https://app.getoutline.com/api
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
```bash
|
|
71
77
|
# Run the project as an SSE server endpoint
|
|
72
78
|
npm run start
|
|
73
79
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "outline-mcp-server",
|
|
3
|
-
"version": "4.2.
|
|
3
|
+
"version": "4.2.1",
|
|
4
4
|
"description": "An MCP server for interacting with Outline's API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -9,6 +9,10 @@
|
|
|
9
9
|
"files": [
|
|
10
10
|
"build"
|
|
11
11
|
],
|
|
12
|
+
"author": {
|
|
13
|
+
"name": "Matt Frey",
|
|
14
|
+
"email": "iam@mattfrey.dev"
|
|
15
|
+
},
|
|
12
16
|
"scripts": {
|
|
13
17
|
"build": "tsc && chmod +x build/index.js",
|
|
14
18
|
"prepare": "npm run build",
|