@steuerboard/mcp 0.0.1 → 0.1.0

package/README.md

@@ -1,6 +1,6 @@
-# steuerboard
+# Steuerboard TypeScript MCP Server
 
-Model Context Protocol (MCP) Server for the *steuerboard* API.
+Model Context Protocol (MCP) Server for the **Steuerboard API**.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=steuerboard&utm_campaign=mcp-typescript"><img src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
@@ -9,10 +9,7 @@ Model Context Protocol (MCP) Server for the *steuerboard* API.
     </a>
 </div>
 
-
 <br /><br />
-> [!IMPORTANT]
-> This MCP Server is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/steuerboard-4kc/mcp). Delete this notice before publishing to a package manager.
 
 <!-- Start Summary [summary] -->
 ## Summary
@@ -23,7 +20,7 @@ For more information about the API: [Find out more about Steuerboard API](https:
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
-* [steuerboard](#steuerboard)
+* [Steuerboard TypeScript MCP Server](#steuerboard-typescript-mcp-server)
   * [Installation](#installation)
   * [Development](#development)
   * [Contributions](#contributions)
@@ -33,8 +30,7 @@ For more information about the API: [Find out more about Steuerboard API](https:
 <!-- Start Installation [installation] -->
 ## Installation
 
-> [!TIP]
-> To finish publishing your MCP Server to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
+Deployed at https://mcp.steuerboard.com
 <details>
 <summary>DXT (Desktop Extension)</summary>
 
@@ -52,7 +48,7 @@ The DXT package includes the MCP server and all necessary configuration. Once in
 <details>
 <summary>Cursor</summary>
 
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=Steuerboard&config=eyJtY3BTZXJ2ZXJzIjp7IlN0ZXVlcmJvYXJkIjp7InR5cGUiOiJtY3AiLCJ1cmwiOiJodHRwczovL2V4YW1wbGUtY2xvdWRmbGFyZS13b3JrZXIuY29tL21jcCIsImhlYWRlcnMiOnsiYXV0aG9yaXphdGlvbiI6IiR7U1RFVUVSQk9BUkRfQkVBUkVSX0FVVEh9In19fX0=)
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=Steuerboard&config=eyJtY3BTZXJ2ZXJzIjp7IlN0ZXVlcmJvYXJkIjp7InR5cGUiOiJtY3AiLCJ1cmwiOiJodHRwczovL21jcC5zdGV1ZXJib2FyZC5jb20vbWNwIiwiaGVhZGVycyI6eyJhdXRob3JpemF0aW9uIjoiJHtAU1RFVUVSQk9BUkQvTUNQX0JFQVJFUl9BVVRIfSJ9fX19)
 
 Or manually:
 
@@ -66,9 +62,9 @@ Or manually:
   "mcpServers": {
     "Steuerboard": {
       "type": "mcp",
-      "url": "https://example-cloudflare-worker.com/mcp",
+      "url": "https://mcp.steuerboard.com/mcp",
       "headers": {
-        "authorization": "${STEUERBOARD_BEARER_AUTH}"
+        "authorization": "${@STEUERBOARD/MCP_BEARER_AUTH}"
       }
     }
   }
@@ -81,7 +77,7 @@ Or manually:
 <summary>Claude Code CLI</summary>
 
 ```bash
-claude mcp add --transport sse Steuerboard undefined/sse --header "authorization: ..."
+claude mcp add --transport sse Steuerboard https://mcp.steuerboard.com/sse --header "authorization: ..."
 ```
 
 </details>
@@ -99,13 +95,11 @@ Refer to [Official Windsurf documentation](https://docs.windsurf.com/windsurf/ca
 {
   "mcpServers": {
     "Steuerboard": {
-      "command": "npx",
-      "args": [
-        "steuerboard",
-        "start",
-        "--bearer-auth",
-        "..."
-      ]
+      "type": "mcp",
+      "url": "https://mcp.steuerboard.com/mcp",
+      "headers": {
+        "authorization": "${@STEUERBOARD/MCP_BEARER_AUTH}"
+      }
     }
   }
 }
@@ -121,15 +115,13 @@ Refer to [Official VS Code documentation](https://code.visualstudio.com/api/exte
 2. If the configuration file is empty paste the full json
 ```
 {
-  "mcpServers": {
+  "servers": {
     "Steuerboard": {
-      "command": "npx",
-      "args": [
-        "steuerboard",
-        "start",
-        "--bearer-auth",
-        "..."
-      ]
+      "type": "mcp",
+      "url": "https://mcp.steuerboard.com/mcp",
+      "headers": {
+        "authorization": "${env:@STEUERBOARD/MCP_BEARER_AUTH}"
+      }
     }
   }
 }
@@ -143,13 +135,13 @@ Refer to [Official VS Code documentation](https://code.visualstudio.com/api/exte
 To start the MCP server, run:
 
 ```bash
-npx steuerboard start --bearer-auth ...
+npx @steuerboard/mcp start --bearer-auth ...
 ```
 
 For a full list of server arguments, run:
 
 ```
-npx steuerboard --help
+npx @steuerboard/mcp --help
 ```
 
 </details>
@@ -160,48 +152,43 @@ npx steuerboard --help
 ## Development
 
 Run locally without a published npm package:
+
 1. Clone this repository
 2. Run `npm install`
 3. Run `npm run build`
 4. Run `node ./bin/mcp-server.js start --bearer-auth ...`
-To use this local version with Cursor, Claude or other MCP Clients, you'll need to add the following config:
+   To use this local version with Cursor, Claude or other MCP Clients, you'll need to add the following config:
 
 ```json
 {
   "mcpServers": {
     "Steuerboard": {
       "command": "node",
-      "args": [
-        "./bin/mcp-server.js",
-        "start",
-        "--bearer-auth",
-        "..."
-      ]
+      "args": ["./bin/mcp-server.js", "start", "--bearer-auth", "..."]
     }
   }
 }
 ```
 
-Or to debug the MCP server locally, use the official MCP Inspector: 
+Or to debug the MCP server locally, use the official MCP Inspector:
 
 ```bash
 npx @modelcontextprotocol/inspector node ./bin/mcp-server.js start --bearer-auth ...
 ```
 
-
 ### Cloudflare Deployment
 
 To deploy to Cloudflare Workers:
 
 ```bash
-npm install 
+npm install
 npm run deploy
 ```
 
 To run the cloudflare deployment locally:
 
 ```bash
-npm install 
+npm install
 npm run dev
 ```
 
@@ -213,13 +200,9 @@ Then install with Claude Code CLI:
 claude mcp add --transport sse Steuerboard http://localhost:8787/sse --header "authorization: ..."
 ```
 
-
-
-
-
 ## Contributions
 
-While we value contributions to this MCP Server, the code is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+While we value contributions to this MCP Server, the code is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
 
 ### MCP Server Created by [Speakeasy](https://www.speakeasy.com/?utm_source=steuerboard&utm_campaign=mcp-typescript)