Add readme

Author: ascorbic

README.md

@@ -1,6 +1,27 @@
+# Astro Docs MCP Server
+
+This is the Model Context Protocol (MCP) server for the Astro documentation, allowing AI tools such as Cursor, VS Code, Claude, ChatGPT, and Windsurf to access the latest Astro docs.
+
+MCP is a standardized way to connect language models to external tools, data, and APIs. This server allows LLMs to access the Astro documentation in a structured way, enabling them to answer questions about Astro's features, APIs, and best practices. This allows tools to use up-to-date and accurate documentation when generating code, answering questions, or providing assistance.
+
+## Usage
+
+The Astro Docs MCP server is a remote server that doesn't require anything to be installed locally. You need to add the following settings to your MCP-compatible tool:
+
+- Name: `Astro Docs`
+- URL: `https://mcp.docs.astro.build/mcp`
+- Transport: `http`
+
+> [!NOTE]
+> This server uses the new _streamable HTTP_ transport. Some tools only support _SSE_ transport for remote servers, which is not compatible with this server. If your tool does not support streamable HTTP, you will need to use a local proxy. See the Windsurf section below for details.
+
+Each tool has its own way of adding MCP servers, so here are instructions for some popular tools:
+
 ### Cursor
 
-Install automatically: [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=Astro%20docs&config=eyJ1cmwiOiJodHRwczovL21jcC5kb2NzLmFzdHJvLmJ1aWxkL21jcCJ9)
+Click the button below to install automatically:
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=Astro%20docs&config=eyJ1cmwiOiJodHRwczovL21jcC5kb2NzLmFzdHJvLmJ1aWxkL21jcCJ9)
 
 [More info on MCP in Cursor](https://docs.cursor.com/context/mcp)
 
@@ -16,6 +37,8 @@ Install automatically: [![Install MCP Server](https://cursor.com/deeplink/mcp-in
 
 ### Claude Code
 
+Run the following command in your terminal to add the MCP server:
+
 ```sh
 claude mcp add --transport http "Astro docs" https://mcp.docs.astro.build/mcp
 ```
@@ -24,7 +47,7 @@ claude mcp add --transport http "Astro docs" https://mcp.docs.astro.build/mcp
 
 ### VS Code
 
-Install automatically: [Install](vscode:mcp/install?%7B%22name%22%3A%22Astro%20docs%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.docs.astro.build%2Fmcp%22%7D)
+Click the link to install automatically: [**Install**](vscode:mcp/install?%7B%22name%22%3A%22Astro%20docs%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.docs.astro.build%2Fmcp%22%7D)
 
 [More info on MCP in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
 
@@ -44,3 +67,7 @@ As of July 2025, Windsurf doesn't support streamable HTTP MCP servers, so you ne
 ```
 
 [More info on MCP in Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json)
+
+### ChatGPT
+
+As of July 2025, ChatGPT only supports MCP servers (which it calls Custom Connectors) for Pro, Team and Enterprise users. The steps to add a cutom connector are complicated. See [the OpenAI documentation](https://platform.openai.com/docs/mcp#test-and-connect-your-mcp-server) for details.