Skip to content

Add npx usage examples for starting the MCP server and configuration #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wham merged 1 commit into from
Feb 2, 2026
Merged

Add npx usage examples for starting the MCP server and configuration #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ npx github-brain@latest
github-brain
```

Or with `npx`:

```sh
npx github-brain@latest
```

Launches the interactive TUI where you can:

1. **Setup** - Configure authentication and settings
Expand Down Expand Up @@ -83,6 +89,12 @@ Start the MCP server using the local database:
github-brain mcp
```

Or with `npx`:

```sh
npx github-brain@latest mcp
```

| Argument | Variable | Description |
| :------- | :------------- | :----------------------------------------- |
| `-o` | `ORGANIZATION` | GitHub organization. **Required.** |
Expand All @@ -105,6 +117,19 @@ Add to the Claude MCP configuration file:
}
```

Or with `npx`:

```json
{
"mcpServers": {
"github-brain": {
"type": "stdio",
"command": "npx",
"args": ["github-brain@latest", "mcp"]
}
}
```

Merge with existing `mcpServers` if present.

### VS Code
Expand All @@ -124,6 +149,21 @@ Add to the VS Code MCP configuration file:
}
```

Or with `npx`:

```json
{
"servers": {
"github-brain": {
"type": "stdio",
"command": "npx",
"args": ["github-brain@latest", "mcp"],
"version": "0.0.1"
}
}
}
```

Merge with existing `servers` if present.

## Development
Expand Down
Loading