Skip to content

Commit 6b1118d

Browse files
authored
feat: Update README for local integration with IDEs and add configuration examples (#85)
* feat: Update README for local integration with IDEs and add configuration examples * chore: bump version to 2.6.1 in pyproject.toml
1 parent 2dd9fb3 commit 6b1118d

File tree

2 files changed

+38
-5
lines changed

2 files changed

+38
-5
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,25 +99,58 @@ uvx ./
9999
```
100100
> You can access it via `sse` i.e. `http(s)://localhost:8080/sse`
101101
102-
## Local Integration with Desktop LLMs
102+
## Local Integration with IDEs and LLMs
103103

104-
To add an MCP server to your desktop LLM such as Claude etc.., you need to add this section to the configuration file. The basic structure involves defining a server name and providing the command and any necessary arguments to run the server.
104+
To add an MCP server to your IDE or LLM, you need to add this section to the configuration file. The basic structure involves defining a server name and providing the command and any necessary arguments to run the server.
105+
106+
<details>
107+
<summary>Claude / Cursor / Windsurf</summary>
105108

106109
```json
107110
{
108111
"mcpServers": {
109-
"github_pr_issues": {
112+
"github_prs_issues": {
110113
"command": "uvx",
111114
"env": {
112115
"GITHUB_TOKEN": "<your-github-token>"
113116
},
114117
"args": [
115-
"https://github.com/saidsef/mcp-github-pr-issue-analyser.git"
118+
"https://github.com/saidsef/mcp-github-pr-issue-analyser.git",
116119
]
117120
}
118121
}
119122
}
120123
```
124+
</details>
125+
126+
<details>
127+
<summary>VS Code</summary>
128+
129+
```json
130+
{
131+
"inputs": [
132+
{
133+
"type": "promptString",
134+
"id": "github-token",
135+
"description": "Enter your GitHub token",
136+
"password": true
137+
}
138+
],
139+
"servers": {
140+
"github-prs-issues": {
141+
"type": "stdio",
142+
"command": "uvx",
143+
"args": [
144+
"https://github.com/saidsef/mcp-github-pr-issue-analyser.git",
145+
],
146+
"env": {
147+
"GITHUB_TOKEN": "${input:github-token}"
148+
}
149+
}
150+
}
151+
}
152+
```
153+
</details>
121154

122155
## Source
123156

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "mcp-github-pr-issue-analyser"
3-
version = "2.6.0"
3+
version = "2.6.1"
44
description = "MCP GitHub Issues Create/Update and PR Analyse"
55
readme = "README.md"
66
requires-python = ">=3.12"

0 commit comments

Comments
 (0)