Skip to content

Commit 9800977

Browse files
authored
Update README.md
1 parent f8a51e6 commit 9800977

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

apps/docs-vectorize/README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,43 @@
1-
# Model Context Protocol (MCP) Server + Cloudflare Documentation (via Vectorize)
1+
# Cloudflare Documentation MCP Server (via Vectorize) 🔭
2+
23

34
This is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that supports remote MCP connections. It connects to a Vectorize DB (in this case, indexed w/ the Cloudflare docs)
45

56
The Cloudflare account this worker is deployed on already has this Vectorize DB setup and indexed.
67

7-
## Running locally
8+
## 🔨 Available Tools
89

9-
```
10-
pnpm run start
11-
```
10+
Currently available tools:
1211

13-
Then connect to the server via remote MCP at `http://localhost:8976/sse`
12+
| **Category** | **Tool** | **Description** |
13+
| --------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| **Workers Analytics** | `search_cloudflare_documentation` | Search the Cloudflare documentation. |
1415

15-
## Deploying
16+
### Prompt Examples
1617

18+
- `Do Cloudflare Workers costs depend on response sizes? I want to serve some images (map tiles) from an R2 bucket and I'm concerned about costs.`
19+
- `How many indexes are supported in Workers Analytics Engine? Give an example using the Workers binding api.`
20+
- `Can you give me some information on how to use the Workers AutoRAG binding`
21+
22+
## Access the remote MCP server from any MCP Client
23+
24+
If your MCP client has first class support for remote MCP servers, the client will provide a way to accept the server URL (`https://docs.mcp.cloudflare.com`) directly within its interface (for example in [Cloudflare AI Playground](https://playground.ai.cloudflare.com/)).
25+
26+
If your client does not yet support remote MCP servers, you will need to set up its resepective configuration file using [mcp-remote](https://www.npmjs.com/package/mcp-remote) to specify which servers your client can access.
27+
28+
Replace the content with the following configuration:
29+
30+
```json
31+
{
32+
"mcpServers": {
33+
"cloudflare": {
34+
"command": "npx",
35+
"args": ["mcp-remote", "https://docs.mcp.cloudflare.com/sse"]
36+
}
37+
}
38+
}
1739
```
18-
pnpm run deploy --env [ENVIRONMENT]
19-
```
40+
41+
Once you've set up your configuration file, restart MCP client and a browser window will open showing your OAuth login page. Proceed through the authentication flow to grant the client access to your MCP server. After you grant access, the tools will become available for you to use.
42+
43+
Interested in contributing, and running this server locally? See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.

0 commit comments

Comments
 (0)