@react-spectrum/mcp 0.1.0 → 1.0.0

package/README.md

@@ -1,21 +1,27 @@
 # @react-spectrum/mcp
 
-The `@react-spectrum/mcp` package allows you to run [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) servers for React Spectrum (S2) and React Aria locally. It exposes a set of tools that MCP clients can discover and call to browse the docs.
+The `@react-spectrum/mcp` package provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server for React Spectrum (S2) documentation. It exposes a set of tools that MCP clients can discover and call to browse the docs, search for icons and illustrations, and more.
 
-## Using with an MCP client
+## Installation
 
-Add one or both servers to your MCP client configuration (the exact file and schema may depend on your client).
+### Quick Start
+
+Simply run the server using npx:
+
+```bash
+npx @react-spectrum/mcp@latest
+```
+
+### Using with an MCP client
+
+Add the server to your MCP client configuration (the exact file and schema may depend on your client).
 
 ```json
 {
   "mcpServers": {
-    "s2-docs": {
+    "React Spectrum (S2)": {
       "command": "npx",
-      "args": ["@react-spectrum/mcp", "s2"]
-    },
-    "react-aria-docs": {
-      "command": "npx",
-      "args": ["@react-spectrum/mcp", "react-aria"]
+      "args": ["@react-spectrum/mcp@latest"]
     }
   }
 }
@@ -26,13 +32,7 @@ Add one or both servers to your MCP client configuration (the exact file and sch
 
 #### Click the button to install:
 
-React Spectrum (S2):
-
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=s2-docs&config=eyJjb21tYW5kIjoibnB4IEByZWFjdC1zcGVjdHJ1bS9tY3AgczIifQ%3D%3D)
-
-React Aria:
-
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=react-aria-docs&config=eyJjb21tYW5kIjoibnB4IEByZWFjdC1zcGVjdHJ1bS9tY3AgcmVhY3QtYXJpYSJ9)
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=React%20Spectrum%20(S2)&config=eyJjb21tYW5kIjoibnB4IEByZWFjdC1zcGVjdHJ1bS9tY3BAbGF0ZXN0In0%3D)
 
 Or follow the MCP install [guide](https://docs.cursor.com/en/context/mcp#installing-mcp-servers) and use the standard config above.
 
@@ -43,23 +43,14 @@ Or follow the MCP install [guide](https://docs.cursor.com/en/context/mcp#install
 
 #### Click the button to install:
 
-React Spectrum (S2):
-
-[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](vscode:mcp/install?%7B%22name%22%3A%22s2-docs%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40react-spectrum%2Fmcp%22%2C%22s2%22%5D%7D)
-
-React Aria:
-
-[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](vscode:mcp/install?%7B%22name%22%3A%22react-aria-docs%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40react-spectrum%2Fmcp%22%2C%22react-aria%22%5D%7D)
-
+[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](vscode:mcp/install?%7B%22name%22%3A%22React%20Spectrum%20(S2)%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40react-spectrum%2Fmcp%40latest%22%5D%7D)
 
 #### Or install manually:
 
-Follow the MCP install [guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) and use the standard config above. You can also add servers using the VS Code CLI:
+Follow the MCP install [guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) and use the standard config above. You can also add the server using the VS Code CLI:
 
 ```bash
-# For VS Code
-code --add-mcp '{"name":"s2-docs","command":"npx","args":["@react-spectrum/mcp","s2"]}'
-code --add-mcp '{"name":"react-aria-docs","command":"npx","args":["@react-spectrum/mcp","react-aria"]}'
+code --add-mcp '{"name":"React Spectrum (S2)","command":"npx","args":["@react-spectrum/mcp@latest"]}'
 ```
 
 </details>
@@ -67,11 +58,10 @@ code --add-mcp '{"name":"react-aria-docs","command":"npx","args":["@react-spectr
 <details>
 <summary>Claude Code</summary>
 
-Use the Claude Code CLI to add the servers:
+Use the Claude Code CLI to add the server:
 
 ```bash
-claude mcp add s2-docs npx @react-spectrum/mcp s2
-claude mcp add react-aria-docs npx @react-spectrum/mcp react-aria
+claude mcp add react-spectrum-s2 npx @react-spectrum/mcp@latest
 ```
 For more information, see the [Claude Code MCP documentation](https://docs.claude.com/en/docs/claude-code/mcp).
 </details>
@@ -82,13 +72,9 @@ For more information, see the [Claude Code MCP documentation](https://docs.claud
 Create or edit the configuration file `~/.codex/config.toml` and add:
 
 ```toml
-[mcp_servers.s2-docs]
-command = "npx"
-args = ["@react-spectrum/mcp", "s2"]
-
-[mcp_servers.react-aria-docs]
+[mcp_servers.react-spectrum-s2]
 command = "npx"
-args = ["@react-spectrum/mcp", "react-aria"]
+args = ["@react-spectrum/mcp@latest"]
 ```
 
 For more information, see the [Codex MCP documentation](https://github.com/openai/codex/blob/main/docs/config.md#mcp_servers).
@@ -98,11 +84,10 @@ For more information, see the [Codex MCP documentation](https://github.com/opena
 <details>
 <summary>Gemini CLI</summary>
 
-Use the Gemini CLI to add the servers:
+Use the Gemini CLI to add the server:
 
 ```bash
-gemini mcp add s2-docs npx @react-spectrum/mcp s2
-gemini mcp add react-aria-docs npx @react-spectrum/mcp react-aria
+gemini mcp add react-spectrum-s2 npx @react-spectrum/mcp@latest
 ```
 
 For more information, see the [Gemini CLI MCP documentation](https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md#how-to-set-up-your-mcp-server).
@@ -120,8 +105,36 @@ Follow Windsurf MCP [documentation](https://docs.windsurf.com/windsurf/cascade/m
 
 | Tool | Input | Description |
 | --- | --- | --- |
-| `list_pages` | `{ includeDescription?: boolean }` | List available pages in the selected docs library. |
-| `get_page_info` | `{ page_name: string }` | Return page description and list of section titles. |
-| `get_page` | `{ page_name: string, section_name?: string }` | Return full page markdown, or only the specified section. |
-| `search_icons` (S2 only) | `{ terms: string or string[] }` | Search S2 workflow icon names. |
-| `search_illustrations` (S2 only) | `{ terms: string or string[] }` | Search S2 illustration names. |
+| `list_s2_pages` | `{ includeDescription?: boolean }` | List available pages in the S2 docs. |
+| `get_s2_page_info` | `{ page_name: string }` | Return page description and list of section titles. |
+| `get_s2_page` | `{ page_name: string, section_name?: string }` | Return full page markdown, or only the specified section. |
+| `search_s2_icons` | `{ terms: string \| string[] }` | Search S2 workflow icon names. |
+| `search_s2_illustrations` | `{ terms: string \| string[] }` | Search S2 illustration names. |
+
+## Development
+
+### Testing locally
+
+Build the docs and MCP server locally, then start the docs server.
+
+```bash
+yarn workspace @react-spectrum/s2-docs generate:md
+yarn workspace @react-spectrum/mcp build
+yarn start:s2-docs
+```
+
+Update your MCP client configuration to use the local MCP server:
+
+```json
+{
+  "mcpServers": {
+    "React Spectrum (S2)": {
+      "command": "node",
+      "args": ["{your path here}/react-spectrum/packages/dev/mcp/s2/dist/s2/src/index.js"],
+      "env": {
+        "DOCS_CDN_BASE": "http://localhost:1234"
+      }
+    }
+  }
+}
+```

package/dist/data/icons.json

@@ -183,6 +183,7 @@
   "GroupNo",
   "Hand",
   "Heart",
+  "HeartFilled",
   "HelpCircle",
   "History",
   "Home",
@@ -219,6 +220,7 @@
   "Mask",
   "MaskDisable",
   "Maximize",
+  "MediaOffline",
   "Mention",
   "MenuHamburger",
   "Microphone",
@@ -323,6 +325,10 @@
   "SwitchVertical",
   "Table",
   "Tag",
+  "TagBold",
+  "TagItalic",
+  "TagStrikeThrough",
+  "TagUnderline",
   "Target",
   "Temperature",
   "Template",
@@ -390,6 +396,7 @@
   "VolumeOff",
   "VolumeOne",
   "VolumeTwo",
+  "Wallet",
   "WebNavBar",
   "WebPage",
   "ZoomIn",

package/dist/data/illustrations.json

@@ -127,6 +127,7 @@
   "NoFile",
   "NoFilter",
   "NoImage",
+  "NoInternetConnection",
   "NoLibraries",
   "NoLibrariesBrands",
   "NoReviewLinks",
@@ -161,6 +162,7 @@
   "Shapes",
   "ShoppingBag",
   "ShoppingCart",
+  "SocialPost",
   "Sparkles",
   "SpeedFast",
   "StampClone",