aboutsummaryrefslogtreecommitdiffstats
path: root/mcp/bridge/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2024-12-11 20:46:17 +0800
committerGitHub <noreply@github.com>2024-12-11 20:46:17 +0800
commit20d1ec47f9970caa119c3715a1c0c7a69e5aa65f (patch)
tree76b0d3585a40ce2b269fa50b54786aa865641920 /mcp/bridge/README.md
parentc58abcbaf89f27e5e3806f4309880a1eac2b7095 (diff)
downloadllm-functions-docker-20d1ec47f9970caa119c3715a1c0c7a69e5aa65f.tar.gz
feat: support MCP bridge (#140)
Diffstat (limited to 'mcp/bridge/README.md')
-rw-r--r--mcp/bridge/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/mcp/bridge/README.md b/mcp/bridge/README.md
new file mode 100644
index 0000000..bffa30c
--- /dev/null
+++ b/mcp/bridge/README.md
@@ -0,0 +1,42 @@
+# MCP-Bridge
+
+Let MCP tools be used by LLM functions.
+
+## Get Started
+
+1. Create a `mpc.json` at `<llm-functions-dir>`.
+
+```json
+{
+ "mcpServers": {
+ "sqlite": {
+ "command": "uvx",
+ "args": [
+ "mcp-server-sqlite",
+ "--db-path",
+ "/tmp/foo.db"
+ ]
+ },
+ "github": {
+ "command": "npx",
+ "args": [
+ "-y",
+ "@modelcontextprotocol/server-github"
+ ],
+ "env": {
+ "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
+ }
+ }
+ }
+}
+```
+
+> MCP-Bridge will launch the server and register all the tools listed by the server. The tool identifier will be `server_toolname` to avoid clashes.
+
+2. Run the bridge server, build mcp tool binaries, update functions.json, all with:
+
+```
+argc mcp start
+```
+
+> Run `argc mcp stop` to stop the bridge server, recover functions.json \ No newline at end of file