petstormcp-cliente 0.1.1

package/README.md

@@ -0,0 +1,282 @@
+# petstormcp-cliente
+
+Model Context Protocol (MCP) Server for the *petstormcp-cliente* API.
+
+[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=petstormcp-cliente&utm_campaign=mcp-typescript)
+[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)
+
+
+<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/testing-t1e/mcp). Delete this notice before publishing to a package manager.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Petstore - OpenAPI 3.1: This is a sample Pet Store Server based on the OpenAPI 3.1 specification.
+
+Some useful links:
+- [OpenAPI Reference](https://www.speakeasy.com/openapi)
+- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
+- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
+
+For more information about the API: [Find out more about Swagger](http://swagger.io)
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [petstormcp-cliente](#petstormcp-cliente)
+  * [Installation](#installation)
+  * [Progressive Discovery](#progressive-discovery)
+  * [Development](#development)
+  * [Publishing to Anthropic MCP Registry](#publishing-to-anthropic-mcp-registry)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- 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).
+<details>
+<summary>Claude Desktop</summary>
+
+Install the MCP server as a Desktop Extension using the pre-built [`mcp-server.mcpb`](https://github.com/JatinJayadev/petstore-mcp-typescript/releases/download/v0.1.1/mcp-server.mcpb) file:
+
+Simply drag and drop the [`mcp-server.mcpb`](https://github.com/JatinJayadev/petstore-mcp-typescript/releases/download/v0.1.1/mcp-server.mcpb) file onto Claude Desktop to install the extension.
+
+The MCP bundle package includes the MCP server and all necessary configuration. Once installed, the server will be available without additional setup.
+
+> [!NOTE]
+> MCP bundles provide a streamlined way to package and distribute MCP servers. Learn more about [Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions).
+
+</details>
+
+<details>
+<summary>Cursor</summary>
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=Petstore&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJwZXRzdG9ybWNwLWNsaWVudGUiLCJzdGFydCIsIi0tZW52aXJvbm1lbnQiLCJwcm9kIiwiLS1hcGkta2V5IiwiIl19)
+
+Or manually:
+
+1. Open Cursor Settings
+2. Select Tools and Integrations
+3. Select New MCP Server
+4. If the configuration file is empty paste the following JSON into the MCP Server Configuration:
+
+```json
+{
+  "command": "npx",
+  "args": [
+    "petstormcp-cliente",
+    "start",
+    "--environment",
+    "prod",
+    "--api-key",
+    ""
+  ]
+}
+```
+
+</details>
+
+<details>
+<summary>Claude Code CLI</summary>
+
+```bash
+claude mcp add Petstore -- npx -y petstormcp-cliente start --environment prod --api-key 
+```
+
+</details>
+<details>
+<summary>Gemini</summary>
+
+```bash
+gemini mcp add Petstore -- npx -y petstormcp-cliente start --environment prod --api-key 
+```
+
+</details>
+<details>
+<summary>Windsurf</summary>
+
+Refer to [Official Windsurf documentation](https://docs.windsurf.com/windsurf/cascade/mcp#adding-a-new-mcp-plugin) for latest information
+
+1. Open Windsurf Settings
+2. Select Cascade on left side menu
+3. Click on `Manage MCPs`. (To Manage MCPs you should be signed in with a Windsurf Account)
+4. Click on `View raw config` to open up the mcp configuration file.
+5. If the configuration file is empty paste the full json
+
+```bash
+{
+  "command": "npx",
+  "args": [
+    "petstormcp-cliente",
+    "start",
+    "--environment",
+    "prod",
+    "--api-key",
+    ""
+  ]
+}
+```
+</details>
+<details>
+<summary>VS Code</summary>
+
+[![Install in VS Code](https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Petstore%20MCP&color=0098FF)](vscode://ms-vscode.vscode-mcp/install?name=Petstore&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJwZXRzdG9ybWNwLWNsaWVudGUiLCJzdGFydCIsIi0tZW52aXJvbm1lbnQiLCJwcm9kIiwiLS1hcGkta2V5IiwiIl19)
+
+Or manually:
+
+Refer to [Official VS Code documentation](https://code.visualstudio.com/api/extension-guides/ai/mcp) for latest information
+
+1. Open [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
+1. Search and open `MCP: Open User Configuration`. This should open mcp.json file
+2. If the configuration file is empty paste the full json
+
+```bash
+{
+  "command": "npx",
+  "args": [
+    "petstormcp-cliente",
+    "start",
+    "--environment",
+    "prod",
+    "--api-key",
+    ""
+  ]
+}
+```
+
+</details>
+<details>
+<summary> Stdio installation via npm </summary>
+To start the MCP server, run:
+
+```bash
+npx petstormcp-cliente start --environment prod --api-key 
+```
+
+For a full list of server arguments, run:
+
+```
+npx petstormcp-cliente --help
+```
+
+</details>
+<!-- End Installation [installation] -->
+
+<!-- Start Progressive Discovery [dynamic-mode] -->
+## Progressive Discovery
+
+MCP servers with many tools can bloat LLM context windows, leading to increased token usage and tool confusion. Dynamic mode solves this by exposing only a small set of meta-tools that let agents progressively discover and invoke tools on demand.
+
+To enable dynamic mode, pass the `--mode dynamic` flag when starting your server:
+
+```jsonc
+{
+  "mcpServers": {
+    "Petstore": {
+      "command": "npx",
+      "args": ["petstormcp-cliente", "start", "--mode", "dynamic"],
+      // ... other server arguments
+    }
+  }
+}
+```
+
+In dynamic mode, the server registers only the following meta-tools instead of every individual tool:
+
+- **`list_tools`**: Lists all available tools with their names and descriptions.
+- **`describe_tool`**: Returns the input schema for one or more tools by name.
+- **`execute_tool`**: Executes a tool by name with the provided input parameters.
+
+This approach significantly reduces the number of tokens sent to the LLM on each request, which is especially useful for servers with a large number of tools.
+<!-- End Progressive Discovery [dynamic-mode] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+## 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 --environment prod --api-key `
+To use this local version with Cursor, Claude or other MCP Clients, you'll need to add the following config:
+
+```json
+{
+  "command": "node",
+  "args": [
+    "./bin/mcp-server.js",
+    "start",
+    "--environment",
+    "prod",
+    "--api-key",
+    ""
+  ]
+}
+```
+
+Or to debug the MCP server locally, use the official MCP Inspector: 
+
+```bash
+npx @modelcontextprotocol/inspector node ./bin/mcp-server.js start --environment prod --api-key 
+```
+
+
+
+## Publishing to Anthropic MCP Registry
+
+This server generates a `server.json` that conforms to the [official MCP Registry schema](https://modelcontextprotocol.io/registry/about). You can publish automatically via your Speakeasy workflow or manually using the `mcp-publisher` CLI.
+
+### Automated Publishing (Recommended)
+
+Add `mcpRegistry` to the `publish` block in your `workflow.yaml`:
+
+```yaml
+targets:
+  my-mcp:
+    target: mcp-typescript
+    source: my-source
+    publish:
+      npm:
+        token: $NPM_TOKEN
+      mcpRegistry:
+        auth: github-oidc  # recommended, no token needed
+```
+
+The `github-oidc` method uses GitHub Actions OIDC — no secrets required. For other auth methods:
+- `github` — requires a `MCP_REGISTRY_TOKEN` secret (GitHub PAT with `read:org` + `read:user` scopes)
+- `dns` — requires a `MCP_REGISTRY_TOKEN` secret (Ed25519 private key for custom domain namespaces)
+
+When the Speakeasy workflow runs, it will automatically publish to npm first, then to the MCP Registry.
+
+### Manual Publishing
+
+If you prefer to publish manually, follow the [official publishing guide](https://github.com/modelcontextprotocol/registry/blob/main/docs/guides/publishing/publish-server.md):
+
+1. **Publish to npm**: `npm publish --access public`
+2. **Install the publisher CLI**:
+   ```bash
+   curl -sL "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher && sudo mv mcp-publisher /usr/local/bin/
+   ```
+3. **Authenticate** (GitHub OAuth for `io.github.*` namespaces):
+   ```bash
+   mcp-publisher login github
+   ```
+4. **Publish**: `mcp-publisher publish`
+5. **Verify**:
+   ```bash
+   curl "https://registry.modelcontextprotocol.io/v0/servers?search=<your-mcp-name>"
+   ```
+
+## 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. 
+
+### MCP Server Created by [Speakeasy](https://www.speakeasy.com/?utm_source=petstormcp-cliente&utm_campaign=mcp-typescript)