stackless-mcp 1.0.0b2__tar.gz

stackless_mcp-1.0.0b2/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

stackless_mcp-1.0.0b2/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: stackless-mcp
+Version: 1.0.0b2
+Summary: Local MCP server exposing Stackless app APIs to terminal agents
+License: Apache-2.0
+License-File: LICENSE
+Keywords: stackless,mcp,analytics,data,cli
+Author: Stackless Data
+Author-email: eng@stacklessdata.com
+Requires-Python: >=3.11,<4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: fastmcp (>=2.0,<3.0)
+Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: keyring (>=25.7.0,<26.0.0)
+Requires-Dist: platformdirs (>=4.0,<5.0)
+Requires-Dist: pydantic (>=2.6.1,<3.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Project-URL: Homepage, https://github.com/OxWorks/stackless
+Project-URL: Issues, https://github.com/OxWorks/stackless/issues
+Project-URL: Repository, https://github.com/OxWorks/stackless
+Description-Content-Type: text/markdown
+
+# Stackless MCP
+
+`stackless-mcp` is a local stdio MCP server for Claude Code, Codex, and other
+terminal agents. It exposes Stackless app capabilities as MCP tools by calling a
+deployed Stackless instance over `/api/v1`.
+
+The MCP process is intentionally thin. It does not import `middleware-service`,
+does not need Snowflake or dbt credentials, and does not read local app data.
+Stackless remains the source of truth for auth, RBAC, ownership, and mutations.
+
+Use this guide when connecting a terminal agent to your own Stackless instance
+from the published `stackless-mcp` package. Development from a monorepo checkout
+is covered separately at the end.
+
+## Prerequisite
+
+Install `uv`. The agent configuration uses `uvx`, which is included with `uv`
+and fetches the pinned `stackless-mcp` package on first run.
+
+## Install
+
+Pin the beta version exactly in your agent configuration:
+`stackless-mcp==1.0.0b2`. The MCP server also needs the base URL for your
+Stackless instance.
+
+### Codex
+
+Add this block to `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.stackless]
+command = "uvx"
+args = [
+  "stackless-mcp==1.0.0b2",
+  "--base-url",
+  "https://your-stackless-instance.example.com",
+]
+```
+
+### Claude Code
+
+Add this block to `.mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "stackless": {
+      "command": "uvx",
+      "args": [
+        "stackless-mcp==1.0.0b2",
+        "--base-url",
+        "https://your-stackless-instance.example.com"
+      ]
+    }
+  }
+}
+```
+
+## Login
+
+Run login once before starting Codex or Claude Code:
+
+```bash
+uvx stackless-mcp==1.0.0b2 login \
+  --base-url https://your-stackless-instance.example.com
+```
+
+`login` opens the Stackless browser auth flow, receives a local callback from the
+authenticated browser session, exchanges it for a scoped `slmcp_` MCP session,
+and stores that session locally. The server-side session defaults to a 30-day
+TTL. Your Stackless instance can lower that lifetime with
+`MCP_SESSION_TTL_SECONDS`.
+
+Credentials are stored in the OS keyring by default. If keyring support is not
+available, use file storage:
+
+```bash
+uvx stackless-mcp==1.0.0b2 login \
+  --base-url https://your-stackless-instance.example.com \
+  --auth-storage file
+```
+
+With `--auth-storage file`, credentials are stored as a `0600`
+`credentials.json` file in the platform user config directory for
+`stackless-mcp`. If you use file storage for login, add
+`"--auth-storage", "file"` to the agent configuration too.
+
+## Verify
+
+```bash
+uvx stackless-mcp==1.0.0b2 --version
+uvx stackless-mcp==1.0.0b2 doctor \
+  --base-url https://your-stackless-instance.example.com
+```
+
+Run `doctor` first when setup does not work. It checks local configuration,
+stored auth, Stackless API connectivity, and server capability discovery.
+
+Example successful output:
+
+```json
+{
+  "auth": {
+    "credential_present": true,
+    "expires_at": "2026-07-10T12:00:00Z",
+    "expiry_status": "unexpired",
+    "mode": "stored_token",
+    "storage_backend": "keyring",
+    "token_present": true,
+    "user_id": "user_123"
+  },
+  "auth_storage": "keyring",
+  "base_url": "https://your-stackless-instance.example.com",
+  "capabilities": {
+    "checked": true,
+    "client_known_unsupported_by_server": [],
+    "error": null,
+    "ok": true,
+    "server_supported_unknown_to_client": [],
+    "server_version": "2026.06.10"
+  },
+  "client_version": "1.0.0b2",
+  "connectivity": {
+    "checked": true,
+    "ok": true
+  },
+  "errors": [],
+  "ok": true,
+  "toolsets": [
+    "all"
+  ]
+}
+```
+
+`doctor` exits `0` when required checks pass and exits `1` for local
+configuration, auth, or connectivity failures. Missing command arguments and
+invalid CLI options exit `2`.
+
+## Troubleshooting
+
+- Missing base URL: pass `--base-url https://...` in the agent config and login
+  command, or set `STACKLESS_BASE_URL`.
+- Expired or missing token: run `uvx stackless-mcp==1.0.0b2 login --base-url
+  https://your-stackless-instance.example.com` again.
+- Server capability delta: `doctor` reports tools known by the client but not
+  supported by the server under `client_known_unsupported_by_server`. Upgrade
+  the Stackless instance when you need those tools; otherwise the client simply
+  advertises the supported subset.
+- Connectivity failure: confirm the base URL is reachable from your machine,
+  uses the correct scheme, and includes no `/api/v1` suffix.
+- Keyring failure: rerun `login` and your agent command with
+  `--auth-storage file`.
+
+For a one-shot connectivity check without starting MCP stdio, run:
+
+```bash
+uvx stackless-mcp==1.0.0b2 \
+  --base-url https://your-stackless-instance.example.com \
+  --check
+```
+
+`--check` uses the stored MCP session when present and exits. Expired sessions
+prompt a fresh `stackless-mcp login` instead of failing with an opaque MCP
+startup error.
+
+## Upgrade
+
+Upgrade by changing the pinned package version in your Codex or Claude Code
+configuration, then restart the agent. Pre-release versions follow PEP 440:
+betas such as `1.0.0b2` must be pinned exactly. For example, change
+`stackless-mcp==1.0.0b2` to `stackless-mcp==1.0.0b3` when that beta is
+published.
+
+## Revoke or Reset Auth
+
+```bash
+uvx stackless-mcp==1.0.0b2 logout \
+  --base-url https://your-stackless-instance.example.com
+uvx stackless-mcp==1.0.0b2 reset-auth \
+  --base-url https://your-stackless-instance.example.com
+```
+
+`logout` calls `/mcp/auth/revoke` and then deletes the local credential.
+`reset-auth` only deletes the local credential, which is useful for stale or
+corrupt local state; the server-side session remains valid until it is revoked
+or expires.
+
+To rotate a file-backed credential, run `logout` with `--auth-storage file`,
+then run `login --auth-storage file` again. Delete any copied backups of the old
+file credential as part of rotation.
+
+## Advanced: Toolsets
+
+This is not part of basic setup. By default, the full supported tool set loads
+and the agent decides which tool to call at runtime. Tool selection is automatic
+and is not a setup choice.
+
+Use `--toolsets` only when you intentionally want to reduce the loaded
+tool-schema surface and agent context:
+
+```toml
+[mcp_servers.stackless]
+command = "uvx"
+args = [
+  "stackless-mcp==1.0.0b2",
+  "--base-url",
+  "https://your-stackless-instance.example.com",
+  "--toolsets",
+  "catalog,runs",
+]
+```
+
+Valid toolsets are `all`, `core`, `catalog`, `runs`, `transformations`,
+`semantic`, `dashboards`, and `lifecycle`. `all` is the default. Core tools for
+auth checks and operation status are always registered; selecting `core`
+registers only those tools. Toolsets are a runtime ergonomics feature, not a
+security boundary. Stackless backend RBAC and tool permissions still enforce
+access.
+
+## Development
+
+Use this path only when developing `stackless-mcp` from a monorepo checkout:
+
+```bash
+cd stackless-mcp
+poetry install --with dev
+poetry run stackless-mcp login \
+  --base-url https://your-stackless-instance.example.com
+poetry run stackless-mcp \
+  --base-url https://your-stackless-instance.example.com
+```
+
+Manual token/cookie setup remains for development and compatibility only:
+
+```bash
+export STACKLESS_BASE_URL=https://your-stackless-instance.example.com
+export STACKLESS_TOKEN='<valid Stackless/Cognito JWT or slmcp token>'
+# or, for browser-cookie development auth:
+# export STACKLESS_COOKIE='AWSALB=...; AWSELBAuthSessionCookie-0=...'
+poetry run stackless-mcp
+```
+
+## Tool Surface
+
+Prefer these workflow-style tools for new agents:
+
+| Tool | Description |
+| --- | --- |
+| `check_stackless_connection` | Check configured Stackless auth/API connectivity. |
+| `find_relevant_data` | Find catalog assets relevant to a business question. |
+| `explain_stackless_asset` | Explain one catalog asset, columns, and lineage handles. |
+| `list_stackless_assets` | List visible catalog assets by type, domain, or tag. |
+| `trace_stackless_lineage` | Trace upstream or downstream catalog lineage. |
+| `get_stackless_column_details` | Get column metadata for a catalog asset. |
+| `refresh_stackless_catalog` | Refresh the catalog snapshot in light or full mode. |
+| `get_stackless_connector_status` | Get connector sync status from the catalog snapshot. |
+| `get_stackless_asset_freshness` | Summarize upstream freshness for a catalog asset. |
+| `list_stackless_snowflake_schemas` | List visible Snowflake schemas from the catalog. |
+| `query_snowflake` | Run direct read-only Snowflake SQL with Stackless guardrails. |
+| `list_stackless_runs` | List recent scheduler runs with stable run refs. |
+| `diagnose_stackless_run` | Diagnose one run or job with redacted logs. |
+| `cancel_stackless_run` | Cancel a pending or running scheduler run. |
+| `draft_transformation_model` | Scaffold or create a Transformation Model draft. |
+| `validate_transformation_model_draft` | Validate a Transformation Model draft. |
+| `preview_transformation_model_draft` | Queue a guarded preview for a Transformation Model draft. |
+| `draft_semantic_model` | Scaffold or create a Semantic Model draft. |
+| `list_stackless_semantic_models` | List visible Semantic Models. |
+| `explain_stackless_semantic_model` | Explain a Semantic Model and queryable members. |
+| `validate_semantic_model_draft` | Validate a Semantic Model draft or payload. |
+| `preview_semantic_model_query` | Run a guarded Semantic Model preview query. |
+| `list_stackless_dashboards` | List visible Stackless dashboards. |
+| `get_stackless_dashboard` | Get dashboard metadata, custom spec, and workflow hints. |
+| `diagnose_stackless_dashboard` | Diagnose custom dashboard widget hydration failures. |
+| `draft_dashboard_from_goal` | Scaffold or create a custom dashboard draft. |
+| `fork_stackless_dashboard` | Fork a published custom dashboard into a private draft. |
+| `update_stackless_dashboard_draft` | Update a private custom dashboard draft. |
+| `hydrate_dashboard` | Hydrate custom dashboard widgets through Stackless/Cube. |
+| `validate_dashboard_draft` | Validate a custom dashboard draft or spec. |
+| `preview_dashboard` | Hydrate a custom dashboard preview through Stackless/Cube. |
+| `diff_stackless_draft` | Inspect draft diff/review output before publication. |
+| `publish_stackless_draft` | Publish a Stackless draft after confirmation. |
+| `unpublish_stackless_resource` | Unpublish a Stackless resource after confirmation. |
+| `delete_stackless_draft` | Delete a draft resource after confirmation. |
+| `get_stackless_operation` | Get status for an MCP operation ID. |
+
+Mutating tools require an `idempotency_key`. Publish, unpublish, cancel, and
+delete also require `confirmation={"confirmed": true, "evidence": "..."}`.
+For `draft_transformation_model`, an `idempotency_key` is required only when a
+`spec` is supplied and a draft is created.
+
+Endpoint-shaped compatibility tools are no longer registered. Use the
+workflow-style tools above for all new MCP agent flows.
+