Skip to content

Commit b4263c6

Browse files
committed
install and document mcp-server-mode too
1 parent e5d42d4 commit b4263c6

File tree

3 files changed

+36
-19
lines changed

3 files changed

+36
-19
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,23 +61,25 @@ ask-mai -b deepseek --llm.deepseek.api-key.plain=YOUR_DEEPSEEK_API_KEY
6161
* Tool Support
6262
* You can define your own tools which can be called from the LLM
6363
* There are some built-in tools:
64-
* "_getSystemInformation" - Get some information about the system
65-
* "_getEnvironment" - Read environment variables from the system
66-
* "_getSystemTime" - Get the current system time
67-
* "_getStats" - Get stats of a file or directory
68-
* "_changeMode" - Changes the mode of file or directory
69-
* "_changeOwner" - Changes the owner of file or directory
70-
* "_changeTimes" - Changes the access and/or modification time of file or directory
71-
* "_createFile" - Create a file on the system
72-
* "_createTempFile" - Create a temporary file on the system
73-
* "_appendFile" - Append content to an existing file
74-
* "_readTextFile" - Read a text file from the system
75-
* "_deleteFile" - Delete a file from the system
76-
* "_createDirectory" - Creates a new directory on the system
77-
* "_createTempDirectory" - Creates a new temporary directory on the system
78-
* "_deleteDirectory" - Delete a directory from the system
79-
* "_executeCommand" - Execute a command on the system
80-
* "_callHttp" - Do a http call
64+
* "getSystemInformation" - Get some information about the system
65+
* "getEnvironment" - Read environment variables from the system
66+
* "getSystemTime" - Get the current system time
67+
* "getStats" - Get stats of a file or directory
68+
* "changeMode" - Changes the mode of file or directory
69+
* "changeOwner" - Changes the owner of file or directory
70+
* "changeTimes" - Changes the access and/or modification time of file or directory
71+
* "createFile" - Create a file on the system
72+
* "createTempFile" - Create a temporary file on the system
73+
* "appendFile" - Append content to an existing file
74+
* "readTextFile" - Read a text file from the system
75+
* "deleteFile" - Delete a file from the system
76+
* "createDirectory" - Creates a new directory on the system
77+
* "createTempDirectory" - Creates a new temporary directory on the system
78+
* "deleteDirectory" - Delete a directory from the system
79+
* "executeCommand" - Execute a command on the system
80+
* "callHttp" - Do a http call
81+
* Run as [MCP](https://www.anthropic.com/news/model-context-protocol)-Server (see below)
82+
* Which allows you to use ask-mai' tools (even **your** custom tools) for other applications which support MCP-Server
8183
* [MCP](https://www.anthropic.com/news/model-context-protocol)-Server support
8284
* You can define multiple MCP-Servers which can be used by the LLM (currently only tools)
8385
* Scriptable
@@ -124,6 +126,18 @@ Available Features:
124126
* console - The binary is console application (only for windows)
125127
* debug - The binary contains devtools (you can inspect the GUI-Sources)
126128

129+
## Start this application as mcp-server
130+
131+
You can start this application as an MCP server by using the `ask-mai-mcp-server` as first positional argument:
132+
```bash
133+
ask-mai ask-mai-mcp-server
134+
```
135+
136+
Or you can rename the binary to `ask-mai-mcp-server` and start it like this:
137+
```bash
138+
ask-mai-mcp-server
139+
```
140+
127141
## How to build this application
128142

129143
1. Install dependencies [see wails documentation](https://wails.io/docs/gettingstarted/installation)

build/generatePKGBUILD.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ package() {
2727
# Binary file
2828
install -Dm755 "\$srcdir/\$pkgname-binary-\$pkgver" "\$pkgdir/usr/bin/ask-mai"
2929
30+
# Symbolic link for mcp-server
31+
ln -s "/usr/bin/ask-mai" "\$pkgdir/usr/bin/ask-mai-mcp-server"
32+
3033
# Icon file
3134
install -Dm644 "build/appicon.png" "\$pkgdir/usr/share/pixmaps/ask-mai.png"
3235
@@ -49,4 +52,4 @@ EOF
4952
# License
5053
install -Dm644 "LICENSE" "\$pkgdir/usr/share/licenses/\$pkgname/LICENSE"
5154
}
52-
EOP
55+
EOP

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func main() {
2323

2424
mode := getMode()
2525

26-
if mode == "ask-mai-mcp" {
26+
if mode == "ask-mai-mcp-server" {
2727
rc = mcp_server.Main(mcp_server.Args{
2828
VersionLine: versionLine(),
2929
})

0 commit comments

Comments
 (0)