Skip to content

Commit 6315cbe

Browse files
cmsparkscmsparks
committed
Add docs autorag
1 parent 4717f26 commit 6315cbe

File tree

12 files changed

+6133
-2
lines changed

12 files changed

+6133
-2
lines changed

‎apps/docs-autorag/.dev.vars.example‎

Whitespace-only changes.

‎apps/docs-autorag/.eslintrc.cjs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/** @type {import("eslint").Linter.Config} */
2+
module.exports = {
3+
root: true,
4+
extends: ['@repo/eslint-config/default.cjs'],
5+
}

‎apps/docs-autorag/README.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Model Context Protocol (MCP) Server + Cloudflare OAuth
2+
3+
This is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that supports remote MCP connections, with Cloudflare OAuth built-in.
4+
5+
You can deploy it to your own Cloudflare account, and after you create your own Cloudflare OAuth client app, you'll have a fully functional remote MCP server that you can build off. Users will be able to connect to your MCP server by signing in with their Cloudflare account.
6+
7+
You can use this as a reference example for how to integrate other OAuth providers with an MCP server deployed to Cloudflare, using the [`workers-oauth-provider` library](https://github.com/cloudflare/workers-oauth-provider).
8+
9+
The MCP server (powered by [Cloudflare Workers](https://developers.cloudflare.com/workers/)):
10+
11+
- Acts as OAuth _Server_ to your MCP clients
12+
- Acts as OAuth _Client_ to your _real_ OAuth server (in this case, Cloudflare)
13+
14+
## Getting Started
15+
16+
### For Production
17+
18+
- Set secrets via Wrangler
19+
20+
```bash
21+
wrangler secret put CLOUDFLARE_CLIENT_ID
22+
wrangler secret put CLOUDFLARE_CLIENT_SECRET
23+
```
24+
25+
#### Set up a KV namespace
26+
27+
- Create the KV namespace:
28+
`wrangler kv:namespace create "OAUTH_KV"`
29+
- Update the Wrangler file with the KV ID
30+
31+
#### Deploy & Test
32+
33+
Deploy the MCP server to make it available on your workers.dev domain
34+
` wrangler deploy`
35+
36+
Test the remote server using [Inspector](https://modelcontextprotocol.io/docs/tools/inspector):
37+
38+
```
39+
npx @modelcontextprotocol/inspector@latest
40+
```
41+
42+
Enter `https://mcp-cloudflare-staging.<your-subdomain>.workers.dev/sse` and hit connect. Once you go through the authentication flow, you'll see the Tools working:
43+
44+
<img width="640" alt="image" src="https://github.com/user-attachments/assets/7973f392-0a9d-4712-b679-6dd23f824287" />
45+
46+
You now have a remote MCP server deployed!
47+
48+
#### Access the remote MCP server from Claude Desktop
49+
50+
Open Claude Desktop and navigate to Settings -> Developer -> Edit Config. This opens the configuration file that controls which MCP servers Claude can access.
51+
52+
Replace the content with the following configuration. Once you restart Claude Desktop, a browser window will open showing your OAuth login page. Complete the authentication flow to grant Claude access to your MCP server. After you grant access, the tools will become available for you to use.
53+
54+
```
55+
{
56+
"mcpServers": {
57+
"cloudflare": {
58+
"command": "npx",
59+
"args": [
60+
"mcp-remote",
61+
"https://<your-subdomain>.workers.dev/sse"
62+
]
63+
}
64+
}
65+
}
66+
```
67+
68+
Once the Tools (under 🔨) show up in the interface, you can ask Claude to use them. For example: "Could you use the math tool to add 23 and 19?". Claude should invoke the tool and show the result generated by the MCP server.
69+
70+
### For Local Development
71+
72+
If you'd like to iterate and test your MCP server, you can do so in local development. This will require you to create another OAuth App on Cloudflare:
73+
74+
- Create a `.dev.vars` file in your project root with:
75+
76+
```
77+
CLOUDFLARE_CLIENT_ID=your_development_cloudflare_client_id
78+
CLOUDFLARE_CLIENT_SECRET=your_development_cloudflare_client_secret
79+
```
80+
81+
#### Develop & Test
82+
83+
Run the server locally to make it available at `http://localhost:8788`
84+
`wrangler dev`
85+
86+
To test the local server, enter `http://localhost:8788/sse` into Inspector and hit connect. Once you follow the prompts, you'll be able to "List Tools".
87+
88+
#### Using Claude and other MCP Clients
89+
90+
When using Claude to connect to your remote MCP server, you may see some error messages. This is because Claude Desktop doesn't yet support remote MCP servers, so it sometimes gets confused. To verify whether the MCP server is connected, hover over the 🔨 icon in the bottom right corner of Claude's interface. You should see your tools available there.
91+
92+
#### Using Cursor and other MCP Clients
93+
94+
To connect Cursor with your MCP server, choose `Type`: "Command" and in the `Command` field, combine the command and args fields into one (e.g. `npx mcp-remote https://<your-worker-name>.<your-subdomain>.workers.dev/sse`).
95+
96+
Note that while Cursor supports HTTP+SSE servers, it doesn't support authentication, so you still need to use `mcp-remote` (and to use a STDIO server, not an HTTP one).
97+
98+
You can connect your MCP server to other MCP clients like Windsurf by opening the client's configuration file, adding the same JSON that was used for the Claude setup, and restarting the MCP client.
99+
100+
## How does it work?
101+
102+
#### OAuth Provider
103+
104+
The OAuth Provider library serves as a complete OAuth 2.1 server implementation for Cloudflare Workers. It handles the complexities of the OAuth flow, including token issuance, validation, and management. In this project, it plays the dual role of:
105+
106+
- Authenticating MCP clients that connect to your server
107+
- Managing the connection to Cloudflare's OAuth services
108+
- Securely storing tokens and authentication state in KV storage
109+
110+
#### Durable MCP
111+
112+
Durable MCP extends the base MCP functionality with Cloudflare's Durable Objects, providing:
113+
114+
- Persistent state management for your MCP server
115+
- Secure storage of authentication context between requests
116+
- Access to authenticated user information via `this.props`
117+
- Support for conditional tool availability based on user identity
118+
119+
#### MCP Remote
120+
121+
The MCP Remote library enables your server to expose tools that can be invoked by MCP clients like the Inspector. It:
122+
123+
- Defines the protocol for communication between clients and your server
124+
- Provides a structured way to define tools
125+
- Handles serialization and deserialization of requests and responses
126+
- Maintains the Server-Sent Events (SSE) connection between clients and your server

‎apps/docs-autorag/package.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "docs-autorag",
3+
"version": "0.0.1",
4+
"private": true,
5+
"scripts": {
6+
"check:lint": "run-eslint-workers",
7+
"check:types": "run-tsc",
8+
"deploy": "wrangler deploy",
9+
"dev": "wrangler dev",
10+
"start": "wrangler dev",
11+
"cf-typegen": "wrangler types",
12+
"test": "vitest run"
13+
},
14+
"dependencies": {
15+
"@cloudflare/workers-oauth-provider": "0.0.2",
16+
"@hono/zod-validator": "0.4.3",
17+
"@modelcontextprotocol/sdk": "1.9.0",
18+
"@repo/mcp-common": "workspace:*",
19+
"agents": "0.0.62",
20+
"cloudflare": "4.2.0",
21+
"hono": "4.7.6",
22+
"mime": "^4.0.6",
23+
"zod": "3.24.2"
24+
},
25+
"devDependencies": {
26+
"@cloudflare/vitest-pool-workers": "0.8.14",
27+
"@cloudflare/workers-types": "4.20250410.0",
28+
"prettier": "3.5.3",
29+
"typescript": "5.5.4",
30+
"vitest": "3.0.9",
31+
"wrangler": "4.10.0"
32+
}
33+
}

‎apps/docs-autorag/src/index.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
2+
import { McpAgent } from 'agents/mcp'
3+
import { registerDocsTools } from './tools/docs'
4+
5+
// The docs MCP server isn't stateful, so we don't have state/props
6+
export type Props = never
7+
8+
export type State = never
9+
10+
export class CloudflareDocumentationMCP extends McpAgent<Env, State, Props> {
11+
server = new McpServer({
12+
name: 'Remote MCP Server with Workers Observability',
13+
version: '1.0.0',
14+
})
15+
16+
constructor(public ctx: DurableObjectState, public env: Env) {
17+
super(ctx, env)
18+
}
19+
20+
async init() {
21+
registerDocsTools(this)
22+
}
23+
}
24+
25+
export default CloudflareDocumentationMCP.mount('/sse')

‎apps/docs-autorag/src/tools/docs.ts‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import { z } from 'zod'
2+
import type { CloudflareDocumentationMCP } from '../index'
3+
import { type EmbeddedResource } from "@modelcontextprotocol/sdk/types.js"
4+
import mime from "mime"
5+
/**
6+
* Registers the docs search tool with the MCP server
7+
* @param agent The MCP server instance
8+
*/
9+
export function registerDocsTools(agent: CloudflareDocumentationMCP) {
10+
// Register the worker logs analysis tool by worker name
11+
agent.server.tool(
12+
'search_cloudflare_documentation',
13+
`Search the Cloudflare documentation.
14+
15+
You should use this tool when:
16+
- A user asks questions about Cloudflare products (Workers, Developer Platform, Zero Trust, CDN, etc)
17+
- A user requests information about a Cloudflare feature
18+
- You are unsure of how to use some Cloudflare functionality
19+
- You are writing Cloudflare Workers code and need to look up Workers-specific documentation
20+
21+
This tool returns a number of results from a vector database. These are embedded as resources in the response and are plaintext doucments in a variety of formats.
22+
`,
23+
{
24+
// partially pulled from autorag query optimization example
25+
query: z.string().describe(`Search query. The query should:
26+
1. Identify the core concepts and intent
27+
2. Add relevant synonyms and related terms
28+
3. Remove irrelevant filler words
29+
4. Structure the query to emphasize key terms
30+
5. Include technical or domain-specific terminology if applicable`),
31+
scoreThreshold: z.number().min(0).max(1).optional().describe("A score threshold (0-1) for which matches should be included."),
32+
maxNumResults: z.number().default(10).optional().describe("The maximum number of results to return.")
33+
},
34+
async (params) => {
35+
// we don't need "rewrite query" OR aiSearch because an LLM writes the query and formats the output for us.
36+
const result = await agent.env.AI.autorag("cloudflare-docs-autorag").search({
37+
query: params.query,
38+
ranking_options: params.scoreThreshold ? {
39+
score_threshold: params.scoreThreshold
40+
} : undefined,
41+
max_num_results: params.maxNumResults
42+
})
43+
44+
const resources: EmbeddedResource[] = result.data.map((result) => {
45+
const content = result.content.reduce((acc, contentPart) => {
46+
return acc + contentPart.text
47+
}, "")
48+
return {
49+
type: "resource",
50+
resource: {
51+
uri: `docs://${result.filename}`,
52+
mimeType: mime.getType(result.filename) ?? "text/plain",
53+
text: content
54+
}
55+
}
56+
})
57+
58+
return {
59+
content: resources
60+
}
61+
}
62+
)
63+
}

‎apps/docs-autorag/tsconfig.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "@repo/typescript-config/workers.json",
3+
"include": ["*/**.ts", "./vitest.config.ts"],
4+
}

‎apps/docs-autorag/types.d.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import type { TestEnv } from './vitest.config'
2+
3+
declare module 'cloudflare:test' {
4+
interface ProvidedEnv extends TestEnv {}
5+
}

‎apps/docs-autorag/vitest.config.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config'
2+
3+
export interface TestEnv extends Env {
4+
CLOUDFLARE_MOCK_ACCOUNT_ID: string
5+
CLOUDFLARE_MOCK_API_TOKEN: string
6+
}
7+
8+
export default defineWorkersConfig({
9+
test: {
10+
poolOptions: {
11+
workers: {
12+
wrangler: { configPath: `${__dirname}/wrangler.jsonc` },
13+
miniflare: {
14+
bindings: {
15+
CLOUDFLARE_MOCK_ACCOUNT_ID: 'mock-account-id',
16+
CLOUDFLARE_MOCK_API_TOKEN: 'mock-api-token',
17+
} satisfies Partial<TestEnv>,
18+
},
19+
},
20+
},
21+
},
22+
})

0 commit comments

Comments
 (0)