more readme changes

src/sentry/README.md

@@ -1,63 +1,131 @@
-# sentry MCP server
+# mcp-server-sentry: A Sentry MCP server
 
-MCP server for retrieving issues from sentry.io
+## Overview
 
-## Components
+A Model Context Protocol server for retrieving and analyzing issues from Sentry.io. This server provides tools to inspect error reports, stacktraces, and other debugging information from your Sentry account.
 
-### Resources
+### Tools
 
-This server does not implement any resources.
+1. `get-sentry-issue`
+   - Retrieve and analyze a Sentry issue by ID or URL
+   - Input:
+     - `issue_id_or_url` (string): Sentry issue ID or URL to analyze
+   - Returns: Issue details including:
+     - Title
+     - Issue ID
+     - Status
+     - Level
+     - First seen timestamp
+     - Last seen timestamp
+     - Event count
+     - Full stacktrace
 
 ### Prompts
 
-The server provides a single prompt:
-- sentry-issue: Retrieves a Sentry issue by ID or URL
-  - Required "issue_id_or_url" argument to specify the issue
-  - Returns issue details including title, status, level, timestamps and stacktrace
+1. `sentry-issue`
+   - Retrieve issue details from Sentry
+   - Input:
+     - `issue_id_or_url` (string): Sentry issue ID or URL
+   - Returns: Formatted issue details as conversation context
 
-### Tools
+## Installation
+
+### Using uv (recommended)
+
+When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
+use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-sentry*.
+
+### Using PIP
+
+Alternatively you can install `mcp-server-sentry` via pip:
+
+```
+pip install mcp-server-sentry
+```
+
+After installation, you can run it as a script using:
+
+```
+python -m mcp_server_sentry
+```
+
+## Configuration
+
+### Usage with Claude Desktop
+
+Add this to your `claude_desktop_config.json`:
+
+<details>
+<summary>Using uvx</summary>
 
-The server implements one tool:
-- get-sentry-issue: Retrieves and analyzes Sentry issues
-  - Takes "issue_id_or_url" as required string argument
-  - Used for investigating production errors and crashes
-  - Provides access to detailed stacktraces
-  - Shows error patterns and frequencies
-  - Includes first/last occurrence timestamps
-  - Displays error counts and status
-
-## Install
-
-### Claude Desktop
-
-On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
-On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
-
-```
-  "mcpServers": {
-    "sentry": {
-      "command": "uv",
-      "args": [
-        "--directory",
-        "/Users/davidsp/code/mcp/servers/src/sentry",
-        "run",
-        "sentry"
-      ]
-    }
+```json
+"mcpServers": {
+  "sentry": {
+    "command": "uvx",
+    "args": ["mcp-server-sentry", "--auth-token", "YOUR_SENTRY_TOKEN"]
   }
+}
 ```
+</details>
 
-## Develop and Debug
+<details>
+<summary>Using pip installation</summary>
 
-Since MCP servers run over stdio, debugging can be challenging. For the best debugging
-experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
+```json
+"mcpServers": {
+  "sentry": {
+    "command": "python",
+    "args": ["-m", "mcp_server_sentry", "--auth-token", "YOUR_SENTRY_TOKEN"]
+  }
+}
+```
+</details>
+
+### Usage with [Zed](https://github.com/zed-industries/zed)
 
+Add to your Zed settings.json:
 
-You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
+<details>
+<summary>Using uvx</summary>
 
-```bash
-npx @modelcontextprotocol/inspector uv --directory /Users/davidsp/code/mcp/servers/src/sentry run sentry
+```json
+"context_servers": [
+  "mcp-server-sentry": {
+    "command": "uvx",
+    "args": ["mcp-server-sentry", "--auth-token", "YOUR_SENTRY_TOKEN"]
+  }
+],
+```
+</details>
+
+<details>
+<summary>Using pip installation</summary>
+
+```json
+"context_servers": {
+  "mcp-server-sentry": {
+    "command": "python",
+    "args": ["-m", "mcp_server_sentry", "--auth-token", "YOUR_SENTRY_TOKEN"]
+  }
+},
+```
+</details>
+
+## Debugging
+
+You can use the MCP inspector to debug the server. For uvx installations:
+
+```
+npx @modelcontextprotocol/inspector uvx mcp-server-sentry --auth-token YOUR_SENTRY_TOKEN
+```
+
+Or if you've installed the package in a specific directory or are developing on it:
+
+```
+cd path/to/servers/src/sentry
+npx @modelcontextprotocol/inspector uv run mcp-server-sentry --auth-token YOUR_SENTRY_TOKEN
 ```
 
+## License
 
-Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
+This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.