Skip to content

Commit c3e60d5

Browse files
committed
Documentation improvements
- Add link to the getting started video - Adjust some getting started details
1 parent da81e7e commit c3e60d5

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ This protocol is an open protocol that standardizes how applications provide con
77
The project name comes from the origins of the word [Guanaco](https://en.wikipedia.org/wiki/Guanaco), a camelid native to
88
South America.
99

10+
[![Getting Started With Wanaku](https://img.youtube.com/vi/-fuNAo2j4SA/0.jpg)](https://www.youtube.com/watch?v=-fuNAo2j4SA)
11+
12+
1013
## Usage Guide
1114

1215
Please follow the [usage guide](docs/usage) to learn how to use Wanaku.

docs/usage.md

+23-8
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,37 @@
1-
# Using the Wanaku MCP Router CLI
1+
# Using the Wanaku MCP Router
2+
3+
Wanaku aims to provide unified access, routing and resource management capabilities for your organization and your AI Agents.
4+
5+
## Meet Wanaku
6+
7+
If you haven't seen it already, we recommend watching the Getting Started with Wanaku video that introduces the project,
8+
and introduces how it works.
9+
10+
[![Getting Started With Wanaku](https://img.youtube.com/vi/-fuNAo2j4SA/0.jpg)](https://www.youtube.com/watch?v=-fuNAo2j4SA)
211

312
## Overview
413

14+
In addition to installing the Wanaku MCP Router, it is also necessary to install the CLI used to manage the router.
515
The Wanaku MCP Router CLI provides a simple way to manage resources and tools for your Wanaku MCP Router instance.
616

7-
## Ways to run the CLI
17+
**NOTE**: Wanaku also comes with a web user interface that you can access on port 8080 of the host running the router, but at
18+
this moment, some features are only available on the CLI.
19+
20+
The MCP endpoint exposed by Wanaku can be accessed on the path `/mcp/sse` of the host your are using (for instance, if running
21+
locally, that would mean `http://localhost:8080/mcp/sse`)
822

9-
There are three ways to run the CLI. Choose the one that fits your the best:
23+
## Getting the CLI
1024

11-
1. Using the container: `podman run quay.io/wanaku/cli`. This is the recommended way.
12-
2. Using the `wanaku` launcher script from the tarball generated during the build
13-
3. Using the `wanaku` native binary generated during the build.
25+
The best way to install the CLI is by downloading the latest `cli` from the [latest release](https://github.com/wanaku-ai/wanaku/releases).
1426

15-
*NOTE*: the commands below will use `wanaku` as the alias representing any of the above options.
27+
*NOTE*: You may also find a container for the CLI on our [Quay.io organization](https://quay.io/repository/wanaku/cli),
28+
although it is not entirely tested at the moment.
1629

1730
## Quick Getting Started
1831

19-
Wanaku needs providers and tools to serve and route. The first step is to launch them.
32+
Wanaku needs providers and tools to serve and route. These are the downstream services that Wanaku talk to.
33+
34+
The first step is to launch them.
2035

2136
Get the [`docker-compose.yml`](https://raw.githubusercontent.com/wanaku-ai/wanaku/refs/heads/main/docker-compose.yml):
2237

0 commit comments

Comments
 (0)