Skip to content

Commit 5b3d91c

Browse files
feat: update readme
1 parent 24256cf commit 5b3d91c

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ dist
88
*.db-*
99
content
1010
tmp
11-
local_cache
11+
local_cache
12+
.DS_Store

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@
66
This MCP server is a tool that allows IDEs (Cursor, Windsurf, Claude Code, etc.) to utilize the Appwrite documentation.
77

88
## Setting up
9+
910
Before setting up, make sure you have Bun installed.
1011

1112
Then, install the dependencies:
1213
```bash
1314
bun install
1415
```
1516

16-
### Environment
17-
Take a look at the `.env.example` file and create a `.env` file with the correct values.
17+
Check out the [.env.example](.env.example) file for the environment variables you need to set.
18+
19+
### Running Locally (Without Docker)
1820

1921
### Initialization
2022
There are three processes involved in setting up the MCP server, to ensure we have the most up-to-date documentation available.
@@ -27,7 +29,7 @@ Simply run the following command to initialize the MCP server:
2729
bun run prepare
2830
```
2931

30-
### Starting the MCP server
32+
### Building and running the MCP server
3133
First, build the server:
3234
```bash
3335
bun run build
@@ -43,12 +45,14 @@ The server should, by default, be available at `http://localhost:1234`.
4345
## Setting up with Docker
4446
Run the following command to build the Docker image:
4547
```bash
46-
bun run init
48+
bun run prepare
4749
docker compose build
4850
docker compose up
4951
```
5052

51-
### Inspecting using the official MCP Inspector
53+
## Usage
54+
55+
### Inspect via the MCP Inspector
5256
Simply run the following command to inspect the MCP server:
5357
```bash
5458
bun run mcp-inspect
@@ -61,7 +65,7 @@ A web browser tab will open up with the inspector interface.
6165
</div>
6266

6367

64-
## Using the MCP server
68+
## Use in your IDE (Cursor, Windsurf, Claude Code, etc.)
6569
Here is a sample configuration file:
6670

6771
```json

0 commit comments

Comments
 (0)