super basic readme

brendan-kellam · brendan-kellam · commit 051a6270b34e · 2025-05-06T19:11:49.000-07:00
diff --git a/packages/mcp/README.md b/packages/mcp/README.md
@@ -1,4 +1,23 @@
-# @sourcebot/mcp
+# Sourcebot MCP - search code on GitHub, GitLab, BitBucket, and more
 
-MCP (Model Context Protocol) server for Sourcebot.
+[![Sourcebot](https://img.shields.io/badge/Website-sourcebot.dev-blue)](https://sourcebot.dev)
+[![GitHub](https://img.shields.io/badge/GitHub-sourcebot--dev%2Fsourcebot-green?logo=github)](https://github.com/sourcebot-dev/sourcebot)
+[![Docs](https://img.shields.io/badge/Docs-docs.sourcebot.dev-yellow)](https://docs.sourcebot.dev/docs/more/mcp-server)
+[![npm](https://img.shields.io/npm/v/@sourcebot/mcp)](https://www.npmjs.com/package/@sourcebot/mcp)
 
+
+An MCP server that provides blazingly fast regex-based code search, allowing LLMs to fetch code context from repositories you don't have checked out.
+
+## Getting Started
+Please follow [these docs](https://docs.sourcebot.dev/docs/more/mcp-server) to get started.
+
+## Supported Code Hosts
+Sourcebot supports the following code hosts:
+- [GitHub](https://docs.sourcebot.dev/docs/connections/github)
+- [GitLab](https://docs.sourcebot.dev/docs/connections/gitlab)
+- [Bitbucket Cloud](https://docs.sourcebot.dev/docs/connections/bitbucket-cloud)
+- [Bitbucket Data Center](https://docs.sourcebot.dev/docs/connections/bitbucket-data-center)
+- [Gitea](https://docs.sourcebot.dev/docs/connections/gitea)
+- [Gerrit](https://docs.sourcebot.dev/docs/connections/gitea)
+
+| Don't see your code host? Open a [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).
