outline-mcp-server 5.3.0 → 5.4.0
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 +15 -7
- package/build/index.js +2 -1
- package/build/tools/createDocument.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
# Outline MCP Server
|
|
2
2
|
|
|
3
|
-
[](https://cursor.com/install-mcp?name=outline&config=eyJjb21tYW5kIjoibnB4IC15IC0tcGFja2FnZT1vdXRsaW5lLW1jcC1zZXJ2ZXJAbGF0ZXN0IC1jIG91dGxpbmUtbWNwLXNlcnZlci1zdGRpbyIsImVudiI6eyJPVVRMSU5FX0FQSV9LRVkiOiI8UkVQTEFDRV9NRT4iLCJPVVRMSU5FX0FQSV9VUkwiOiJodHRwczovL2FwcC5nZXRvdXRsaW5lLmNvbS9hcGkifX0%3D)
|
|
4
|
-
|
|
5
3
|
 • 
|
|
6
4
|
|
|
7
5
|
A Model Context Protocol (MCP) server that provides tools for interacting with [Outline](https://www.getoutline.com/)'s API, enabling AI agents to manage documents, collections, and other entities programmatically through the Outline knowledge base platform.
|
|
8
6
|
|
|
9
|
-
##
|
|
7
|
+
## Quick Installation
|
|
8
|
+
|
|
9
|
+
### Claude Desktop
|
|
10
|
+
|
|
11
|
+
🎉 **`outline-mcp-server` now has an extension for Claude Desktop!**
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
You can now download a Claude Desktop extension from the [releases page](https://github.com/mmmeff/outline-mcp/releases) for quick and easy setup (just double click it).
|
|
14
|
+
|
|
15
|
+
### Cursor
|
|
16
|
+
|
|
17
|
+
One click install in Cursor:
|
|
18
|
+
|
|
19
|
+
[](https://cursor.com/install-mcp?name=outline&config=eyJjb21tYW5kIjoibnB4IC15IC0tcGFja2FnZT1vdXRsaW5lLW1jcC1zZXJ2ZXJAbGF0ZXN0IC1jIG91dGxpbmUtbWNwLXNlcnZlci1zdGRpbyIsImVudiI6eyJPVVRMSU5FX0FQSV9LRVkiOiI8UkVQTEFDRV9NRT4iLCJPVVRMSU5FX0FQSV9VUkwiOiJodHRwczovL2FwcC5nZXRvdXRsaW5lLmNvbS9hcGkifX0%3D)
|
|
14
20
|
|
|
15
21
|
## Features
|
|
16
22
|
|
|
@@ -72,7 +78,8 @@ Add the following MCP definition to your configuration:
|
|
|
72
78
|
"env": {
|
|
73
79
|
"OUTLINE_API_KEY": "<REPLACE_ME>",
|
|
74
80
|
"OUTLINE_API_URL": "https://app.getoutline.com/api",
|
|
75
|
-
"OUTLINE_MCP_PORT": "6060"
|
|
81
|
+
"OUTLINE_MCP_PORT": "6060",
|
|
82
|
+
"OUTLINE_MCP_HOST": "127.0.0.1"
|
|
76
83
|
}
|
|
77
84
|
}
|
|
78
85
|
}
|
|
@@ -83,6 +90,7 @@ Add the following MCP definition to your configuration:
|
|
|
83
90
|
- `OUTLINE_API_KEY` (_required_): your API key for outline, duh
|
|
84
91
|
- `OUTLINE_API_URL` (_optional_): Alternative URL for your outline API (if using an alt domain/self-hosting)
|
|
85
92
|
- `OUTLINE_MCP_PORT` (_optional_): Specify the port on which the server will run (default: 6060)
|
|
93
|
+
- `OUTLINE_MCP_HOST` (_optional_): Host/IP to bind the server to (default: 127.0.0.1). Use 0.0.0.0 to bind to all network interfaces
|
|
86
94
|
|
|
87
95
|
### Usage
|
|
88
96
|
|
package/build/index.js
CHANGED
|
@@ -85,7 +85,8 @@ app.post('/messages', async (req, res) => {
|
|
|
85
85
|
await sseTransport.handlePostMessage(req.raw, res.raw, req.body);
|
|
86
86
|
});
|
|
87
87
|
const PORT = process.env.OUTLINE_MCP_PORT ? parseInt(process.env.OUTLINE_MCP_PORT, 10) : 6060;
|
|
88
|
-
|
|
88
|
+
const HOST = process.env.OUTLINE_MCP_HOST || '127.0.0.1';
|
|
89
|
+
app.listen({ port: PORT, host: HOST }, (err, address) => {
|
|
89
90
|
if (err) {
|
|
90
91
|
console.error(err);
|
|
91
92
|
process.exit(1);
|
|
@@ -33,7 +33,7 @@ toolRegistry.register('create_document', {
|
|
|
33
33
|
if (args.template !== undefined) {
|
|
34
34
|
payload.template = args.template;
|
|
35
35
|
}
|
|
36
|
-
const response = await outlineClient.post('/documents', payload);
|
|
36
|
+
const response = await outlineClient.post('/documents.create', payload);
|
|
37
37
|
return { content: [{ type: 'text', text: JSON.stringify(response.data.data) }] };
|
|
38
38
|
}
|
|
39
39
|
catch (error) {
|