Skip to content

Commit 3a87baf

Browse files
committed
Update readmes
1 parent f0d81be commit 3a87baf

File tree

2 files changed

+8
-41
lines changed

2 files changed

+8
-41
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,8 @@ GITHUB_BASE_URL=https://github.com
8181
GITHUB_APP_CWD=/Users/username/project/your-repo
8282
```
8383

84-
#### MCP Configuration
84+
#### Public URL Configuration
8585
```env
86-
# MCP Server Authentication
87-
MCP_AUTH_TOKEN=your_mcp_secret
88-
8986
# Public URL for webhooks (use ngrok or similar for development)
9087
CRA_PUBLIC_URL=https://ngrok-your-url.app
9188
```
@@ -169,10 +166,7 @@ To adjust review focus, modify the `prompt_template` section in `config.yml` to
169166
- `GET /github/callback` - GitHub App installation callback
170167
- `GET /github/dashboard/:installationId` - Installation dashboard
171168

172-
### MCP Server Endpoints
173-
- `GET /mcp/tools/list` - List available MCP tools
174-
- `POST /mcp/tools/call` - Call an MCP tool
175-
- `GET /mcp/health` - MCP server health check
169+
176170

177171
## Development
178172

@@ -236,7 +230,7 @@ The app includes a Model Context Protocol (MCP) server that exposes GitHub opera
236230
- `get_pr_comments` - Get all comments on a pull request
237231

238232
### Usage with AI Agents
239-
The MCP server can be accessed via HTTP at `/mcp` endpoints or run as a standalone stdio server. See [`src/mcp/README.md`](src/mcp/README.md) for detailed configuration and usage instructions.
233+
The MCP server runs as a standalone stdio server. See [`src/mcp/README.md`](src/mcp/README.md) for detailed configuration and usage instructions.
240234

241235
## Architecture
242236

src/mcp/README.md

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -67,27 +67,7 @@ Get all comments on a pull request.
6767

6868
## Usage
6969

70-
### HTTP Server (for mcp-remote)
71-
72-
The MCP server is exposed via HTTP endpoints at `/mcp` when the main server is running.
73-
74-
**Endpoints:**
75-
- `GET /mcp/tools/list` - List available tools
76-
- `POST /mcp/tools/call` - Call a tool
77-
- `GET /mcp/health` - Health check
78-
79-
**Authentication:**
80-
Set the `MCP_AUTH_TOKEN` environment variable and include it in requests:
81-
```
82-
Authorization: Bearer <your-token>
83-
```
84-
85-
**Usage with mcp-remote:**
86-
```bash
87-
npx mcp-remote http://localhost:5053/mcp --header "Authorization: Bearer your-token"
88-
```
89-
90-
### Standalone STDIO Server
70+
### STDIO Server
9171

9272
Run the standalone MCP server for direct stdio communication:
9373

@@ -108,7 +88,6 @@ The server uses the same configuration as the main application. Make sure your `
10888
- `GITHUB_APP_ID` - GitHub App ID
10989
- `GITHUB_APP_PRIVATE_KEY` or `GITHUB_APP_PRIVATE_KEY_PATH` - GitHub App private key
11090
- `GITHUB_BASE_URL` - GitHub API URL (default: https://api.github.com)
111-
- `MCP_AUTH_TOKEN` - Token for MCP server authentication (optional)
11291

11392
### GitHub App Integration
11493
The MCP server works with GitHub App installations for authentication. When accessing repositories, it uses the GitHub App's installation tokens rather than personal access tokens.
@@ -123,14 +102,9 @@ Add to your Cursor settings:
123102
{
124103
"mcp.servers": {
125104
"github": {
126-
"command": "npx",
127-
"args": [
128-
"-y",
129-
"mcp-remote",
130-
"http://localhost:5053/mcp",
131-
"--header",
132-
"Authorization: Bearer your-mcp-token"
133-
]
105+
"command": "npm",
106+
"args": ["run", "mcp"],
107+
"cwd": "/path/to/your/cra-github/project"
134108
}
135109
}
136110
}
@@ -192,6 +166,5 @@ The tools are organized in the `/src/mcp/tools/` directory:
192166
- `get_pr_comments.ts` - PR comments retrieval
193167
- `trigger_review.ts` - Review triggering
194168

195-
The server implementations are:
169+
The server implementation is:
196170
- `server.ts` - Standalone stdio MCP server
197-
- `http-server.ts` - HTTP adapter for mcp-remote

0 commit comments

Comments
 (0)