Skip to content

Commit 77c5b95

Browse files
authored
Update README.md (#76)
1 parent 558b30b commit 77c5b95

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@
2020
</div>
2121

2222
## What is GitMCP?
23-
**The end to vibe-hallucinating!** [GitMCP](https://gitmcp.io) is a free, open-source, remote [Model Context Protocol (MCP)](https://docs.anthropic.com/en/docs/agents-and-tools/mcp) server that transforms **any** GitHub project (repositories or GitHub pages) to a documentation hub. It allows AI tools like Cursor to seamlessly access up-to-date documentation and code, putting an end to hallucinations.
23+
**The end to vibe-hallucinating!** [GitMCP](https://gitmcp.io) is a free, open-source, remote [Model Context Protocol (MCP)](https://docs.anthropic.com/en/docs/agents-and-tools/mcp) server that transforms **any** GitHub project (repositories or GitHub pages) into a documentation hub. It allows AI tools like Cursor to access up-to-date documentation and code, ending hallucinations seamlessly.
2424

2525

2626
## Features
2727

28-
-**Latest Documentation on Any GitHub project**: Grant your AI assistant seamless access to GitHub project's documentation and code. The built-in smart search capabilities help find exactly what the AI needs without using too many tokens!
29-
- 👌 **Zero Setup**: Simply add the chosen GitMCP URL as an MCP server in your IDE - no downloads, installations, signups, or changes required.
30-
-**Free and Private**: GitMCP is open-source and is completely free to use. It doesn't collect any personal information or store your queries. You can even self-host it!
28+
-**Latest Documentation on Any GitHub project**: Grant your AI assistant seamless access to the GitHub project's documentation and code. The built-in smart search capabilities help find exactly what the AI needs without using too many tokens!
29+
- 👌 **Zero Setup**: Simply add the chosen GitMCP URL as an MCP server in your IDE no downloads, installations, signups, or changes are required.
30+
-**Free and Private**: GitMCP is open-source and completely free to use. It doesn't collect personal information or store queries. You can even self-host it!
3131

3232
<video src="https://github.com/user-attachments/assets/2c3afaf9-6c08-436e-9efd-db8710554430"></video>
3333

@@ -126,15 +126,15 @@ Select your AI assistant from the options below and follow the configuration ins
126126
127127
## How It Works
128128

129-
GitMCP connects your AI assistant to GitHub repositories using the Model Context Protocol (MCP), which is a standard that lets AI tools request additional information from external sources.
129+
GitMCP connects your AI assistant to GitHub repositories using the Model Context Protocol (MCP), a standard that lets AI tools request additional information from external sources.
130130

131131
What happens when you use GitMCP:
132132

133133
1. **You provide the GitMCP URL** to your AI assistant (e.g., `gitmcp.io/microsoft/typescript`). GitMCP exposes tools like documentation fetching, smart search, code search, etc.
134-
2. **Prompt the AI assistant** on a documentation/code-related questions.
135-
3. **Your AI send requests** to GitMCP to use its tools (with your approval).
134+
2. **Prompt the AI assistant** on documentation/code-related questions.
135+
3. **Your AI sends requests** to GitMCP to use its tools (with your approval).
136136
4. **GitMCP executes the AI's request** and returns the requested data.
137-
5. **Your AI receives the information** and generates a more accurate, grounded, response without hallucinations.
137+
5. **Your AI receives the information** and generates a more accurate, grounded response without hallucinations.
138138

139139
## Examples
140140

@@ -147,7 +147,7 @@ For the GitHub repository `https://github.com/microsoft/playwright-mcp`, add `ht
147147
**Prompt to Claude:**
148148
> "How do I use the Playwright MCP"
149149
150-
Windsurf will pull the relevant documentation from GitMCP to correctly implement the memory feature.
150+
Windsurf will pull the relevant documentation from GitMCP to implement the memory feature correctly.
151151

152152
### Example 2: Using Cursor with a GitHub Pages site
153153

@@ -169,11 +169,11 @@ Claude will pull the data from GitMCP and answer the question.
169169

170170
## Tools
171171

172-
GitMCP provides AI assistants with several useful tools to help them access and understand GitHub repositories. These tools XXXXXX
172+
GitMCP provides AI assistants with several valuable tools to help them access, understand, and query GitHub repositories.
173173

174174
### `fetch_<repo-name>_documentation`
175175

176-
This tool gets the main documentation from a GitHub repository. It works by retrieving relevant documentation (e.g., `llms.txt`). This gives the AI a good overview of what the project is about
176+
This tool gets the primary documentation from a GitHub repository. It works by retrieving relevant documentation (e.g., `llms.txt`). This gives the AI a good overview of what the project is about
177177

178178
**When it's useful:** For general questions about a project's purpose, features, or how to get started
179179

0 commit comments

Comments
 (0)