Skip to content

Commit a86ab91

Browse files
committed
update top level readme/contributing
1 parent a1c3a48 commit a86ab91

File tree

3 files changed

+21
-10
lines changed

3 files changed

+21
-10
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Developing
2+
We welcome contributions to all of our MCP servers! Here's a quick run down on how to get started.
23

34
## Architecture
45

5-
The monorepo has two top-level directories:
6+
This monorepo has two top-level directories: `/apps` and `/packages`.
67

7-
- apps: Contains the Workers for each MCP server
8-
- apps/workers-observability
9-
- apps/workers-bindings
10-
- [apps/radar/CONTRIBUTING.md](apps/radar/CONTRIBUTING.md)
11-
- apps/cloudflare-one-casb
12-
- packages: Contains shared packages used across our various apps.
8+
- **/apps**: Containing directories for each server. Within each server, you'll find a `CONTRIBUTING.md` with any special instructions on how to get set up:
9+
- [apps/workers-observability](apps/workers-observability)
10+
- [apps/workers-bindings](apps/workers-bindings)
11+
- [apps/radar](apps/radar)
12+
- [apps/cloudflare-one-casb](apps/cloudflare-one-casb)
13+
- **/packages**: Containing shared packages used across our various apps.
1314
- packages/eslint-config: Eslint config used by all apps and packages.
1415
- packages/typescript-config: tsconfig used by all apps and packages.
1516
- packages/mcp-common: Shared common tools and scripts to help manage this repo.
@@ -20,7 +21,13 @@ We use [TurboRepo](https://turbo.build/) and [pnpm](https://pnpm.io/) to manage
2021

2122
This section will guide you through setting up your developer environment and running tests.
2223

23-
For more details on development in this monorepo, take a look at apps/workers-observability/CONTRIBUTING.md[/apps/workers-observability/CONTRIBUTING.md]
24+
### Installation
25+
26+
Install dependencies:
27+
28+
```bash
29+
pnpm install
30+
```
2431

2532
### Testing
2633

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Cloudflare MCP Server
22

3-
Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) for managing context between large language models (LLMs) and external systems. In this repository, you can find several MCP servers allowing you to connect to Cloudflare's service from an MCP client (e.g. Cursor, Claude Desktop) and use natural language to accomplish things on your Cloudflare account. The following servers are included in this repository:
3+
Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) for managing context between large language models (LLMs) and external systems. In this repository, you can find several MCP servers allowing you to connect to Cloudflare's service from an MCP client (e.g. Cursor, Claude) and use natural language to accomplish tasks through your Cloudflare account.
4+
5+
These MCP servers allow your [MCP Client](https://modelcontextprotocol.io/clients) to read configurations from your account, process information, make suggestions based on data, and even make those suggested changes for you. All of these actions can happen across cloudflare's many services including application development, security and performance.
6+
7+
The following servers are included in this repository:
48

59
| Server Name | Description | Server URL |
610
| ----------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------- |

apps/radar/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This MCP server is still a work in progress, and we plan to add more tools in th
3636

3737
## Access the remote MCP server from from any MCP Client
3838

39-
If your MCP client has first class support for remote MCP servers, the client will provide a way to accept the server URL directly within its interface (e.g. [Cloudflare AI Playground](https://playground.ai.cloudflare.com/))
39+
If your MCP client has first class support for remote MCP servers, the client will provide a way to accept the server URL (`https://radar.mcp.cloudflare.com`) directly within its interface (for example in[Cloudflare AI Playground](https://playground.ai.cloudflare.com/)).
4040

4141
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.
4242

0 commit comments

Comments
 (0)