supercarto 0.3.0__tar.gz

supercarto-0.3.0/.gitignore

@@ -0,0 +1,21 @@
+node_modules/
+dist/
+*.tsbuildinfo
+.DS_Store
+.vitest/
+coverage/
+tmp/
+test-dist/
+smoke/
+
+# Python
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+python/build/
+python/dist/
+.venv/
+venv/

supercarto-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

supercarto-0.3.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.5
+Name: supercarto
+Version: 0.3.0
+Summary: LLM-native spatial middleware. Give an AI agent a map of any location on earth as a token-budgeted topological graph, with indoor floors, weather, and traffic.
+Project-URL: Homepage, https://github.com/supercarto/supercarto
+Project-URL: Repository, https://github.com/supercarto/supercarto
+Project-URL: Issues, https://github.com/supercarto/supercarto/issues
+Project-URL: Benchmark, https://github.com/supercarto/supercarto/blob/main/docs/benchmark.md
+Author: supercarto contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,geospatial,gis,indoor-maps,llm,mcp,openstreetmap,routing,token-efficiency,topology,traffic,weather
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# supercarto (Python)
+
+LLM-native spatial middleware for Python. Give an AI agent a map of any
+location on earth as a token-budgeted topological graph it can reason over.
+
+```bash
+pip install supercarto
+```
+
+This package is a **client**. The map compilation, token budgeting, topology
+work, and indoor graph live in the Node library, and this speaks MCP to it over
+stdio. That is deliberate: those algorithms are the product, and a second
+implementation in a second language would be a second thing to keep correct.
+
+**Node 20 or newer is required to call anything.** `pip install` alone will
+succeed; the error when you call will tell you exactly what to install.
+
+```bash
+npm install -g supercarto     # or: npx supercarto mcp
+```
+
+---
+
+## Use
+
+```python
+import asyncio
+from supercarto import SuperCarto
+
+async def main():
+    async with SuperCarto() as carto:
+        m = await carto.maplet(lat=35.6833, lon=139.7620, radius_m=400, budget=1500)
+        print(m.yaml)
+        print(f"{m.tokens} tokens, from {m.fetched_from}")
+
+asyncio.run(main())
+```
+
+```
+map:
+  center: "35.6833, 139.762"
+  radius: 400m
+nodes:
+  n8: {type: transit, name: 芝浦ふ頭, tags: [station]}
+edges:
+  n1->n2: {dist: 120m, dir: east, path: road}
+omitted:
+  - {layer: feature, count: 1754}
+```
+
+The budget holds. The server measures its own output and cuts until it fits, so
+`m.tokens` will not exceed `m.budget`.
+
+### Routing
+
+```python
+r = await carto.route(37.7749, -122.4194, 37.7849, -122.4194, mode="walk")
+
+r.distance_m, r.duration_s
+r.steps  # ["1. head onto Mission St (120m)", ...]
+r.source # "osrm", or "straight-line" for the labelled approximation
+```
+
+### Weather
+
+No API key needed.
+
+```python
+w = await carto.weather(35.6833, 139.7620, hours=12)
+
+w.summary          # "heavy rain"
+w.precipitation    # "rain" | "snow" | "sleet" | "hail" | "drizzle"
+w.feels_like_c     # what a person actually feels
+w.advisory         # prose, in the vocabulary of the decision
+```
+
+### Traffic
+
+Needs `TOMTOM_API_KEY` or `HERE_API_KEY` in the environment.
+
+```python
+t = await carto.traffic(37.7749, -122.4194, 37.7849, -122.4194)
+
+if t.free_flow_only:
+    # No credential. The duration ignores congestion entirely. Do not quote it
+    # as an arrival time.
+    ...
+
+t.worst_level  # the segment that actually makes someone late
+```
+
+`traffic()` raises `ToolError` when no credential is configured. That is on
+purpose: a free-flow number returned as if it were live is the failure this
+library exists to avoid.
+
+### Checking what is available
+
+```python
+tools = await carto.tools()
+```
+
+Worth doing before a loop. `get_traffic` is **absent** unless a flow credential
+is present, and `get_weather` is **present** by default because its source needs
+no key. A maplet lists exactly the tools this deployment can answer.
+
+---
+
+## In an agent framework
+
+Any MCP client works; this package is for when you want the typed results.
+
+```python
+# LangChain-style MCP config
+{
+    "mcpServers": {
+        "supercarto": {"command": "npx", "args": ["supercarto", "mcp"]}
+    }
+}
+```
+
+---
+
+## Configuration
+
+Read from the environment by the server, so nothing is needed on the Python side.
+
+```
+SUPERCARTO_PMTILES      PMTiles archive; the production data source
+OVERPASS_ENDPOINT       your own Overpass instance
+TOMTOM_API_KEY          enables live traffic
+HERE_API_KEY            enables live traffic
+```
+
+Point at a specific binary with `SUPERCARTO_SERVER_CMD`, or pass `command=[...]`
+to the constructor. A relative or absolute path both work:
+
+```python
+carto = SuperCarto(command=["node", "/opt/sc/dist/cli/main.js", "mcp"])
+```
+
+---
+
+## Errors
+
+| Exception | Meaning |
+|---|---|
+| `SuperCartoConnectionError` | The server could not start or did not respond. Your problem. |
+| `ToolError` | The tool ran and reported a failure. Usually a real answer, like "traffic is not configured". |
+
+They are deliberately distinct. Conflating them would make a retry loop hammer
+a server that is behaving correctly.
+
+---
+
+## Zero dependencies
+
+This package has no runtime dependencies, on purpose.
+
+The `mcp` SDK pulls in httpx, pydantic, and their transitive trees. An agent
+framework that already depends on any of those should not get a second copy at a
+different version. Three JSON-RPC methods and one line-delimited framing are
+small enough to implement directly, which is what `client.py` does.
+
+The trade: `pip install supercarto` does not bring Node with it. Calling anything
+raises a `SuperCartoConnectionError` that says so, with the fix, in one sentence.
+
+---
+
+## Links
+
+- **npm:** https://www.npmjs.com/package/supercarto
+- **Repository:** https://github.com/supercarto/supercarto
+- **Benchmark:** https://github.com/supercarto/supercarto/blob/main/docs/benchmark.md
+
+Apache-2.0

supercarto-0.3.0/README.md

@@ -0,0 +1,175 @@
+# supercarto (Python)
+
+LLM-native spatial middleware for Python. Give an AI agent a map of any
+location on earth as a token-budgeted topological graph it can reason over.
+
+```bash
+pip install supercarto
+```
+
+This package is a **client**. The map compilation, token budgeting, topology
+work, and indoor graph live in the Node library, and this speaks MCP to it over
+stdio. That is deliberate: those algorithms are the product, and a second
+implementation in a second language would be a second thing to keep correct.
+
+**Node 20 or newer is required to call anything.** `pip install` alone will
+succeed; the error when you call will tell you exactly what to install.
+
+```bash
+npm install -g supercarto     # or: npx supercarto mcp
+```
+
+---
+
+## Use
+
+```python
+import asyncio
+from supercarto import SuperCarto
+
+async def main():
+    async with SuperCarto() as carto:
+        m = await carto.maplet(lat=35.6833, lon=139.7620, radius_m=400, budget=1500)
+        print(m.yaml)
+        print(f"{m.tokens} tokens, from {m.fetched_from}")
+
+asyncio.run(main())
+```
+
+```
+map:
+  center: "35.6833, 139.762"
+  radius: 400m
+nodes:
+  n8: {type: transit, name: 芝浦ふ頭, tags: [station]}
+edges:
+  n1->n2: {dist: 120m, dir: east, path: road}
+omitted:
+  - {layer: feature, count: 1754}
+```
+
+The budget holds. The server measures its own output and cuts until it fits, so
+`m.tokens` will not exceed `m.budget`.
+
+### Routing
+
+```python
+r = await carto.route(37.7749, -122.4194, 37.7849, -122.4194, mode="walk")
+
+r.distance_m, r.duration_s
+r.steps  # ["1. head onto Mission St (120m)", ...]
+r.source # "osrm", or "straight-line" for the labelled approximation
+```
+
+### Weather
+
+No API key needed.
+
+```python
+w = await carto.weather(35.6833, 139.7620, hours=12)
+
+w.summary          # "heavy rain"
+w.precipitation    # "rain" | "snow" | "sleet" | "hail" | "drizzle"
+w.feels_like_c     # what a person actually feels
+w.advisory         # prose, in the vocabulary of the decision
+```
+
+### Traffic
+
+Needs `TOMTOM_API_KEY` or `HERE_API_KEY` in the environment.
+
+```python
+t = await carto.traffic(37.7749, -122.4194, 37.7849, -122.4194)
+
+if t.free_flow_only:
+    # No credential. The duration ignores congestion entirely. Do not quote it
+    # as an arrival time.
+    ...
+
+t.worst_level  # the segment that actually makes someone late
+```
+
+`traffic()` raises `ToolError` when no credential is configured. That is on
+purpose: a free-flow number returned as if it were live is the failure this
+library exists to avoid.
+
+### Checking what is available
+
+```python
+tools = await carto.tools()
+```
+
+Worth doing before a loop. `get_traffic` is **absent** unless a flow credential
+is present, and `get_weather` is **present** by default because its source needs
+no key. A maplet lists exactly the tools this deployment can answer.
+
+---
+
+## In an agent framework
+
+Any MCP client works; this package is for when you want the typed results.
+
+```python
+# LangChain-style MCP config
+{
+    "mcpServers": {
+        "supercarto": {"command": "npx", "args": ["supercarto", "mcp"]}
+    }
+}
+```
+
+---
+
+## Configuration
+
+Read from the environment by the server, so nothing is needed on the Python side.
+
+```
+SUPERCARTO_PMTILES      PMTiles archive; the production data source
+OVERPASS_ENDPOINT       your own Overpass instance
+TOMTOM_API_KEY          enables live traffic
+HERE_API_KEY            enables live traffic
+```
+
+Point at a specific binary with `SUPERCARTO_SERVER_CMD`, or pass `command=[...]`
+to the constructor. A relative or absolute path both work:
+
+```python
+carto = SuperCarto(command=["node", "/opt/sc/dist/cli/main.js", "mcp"])
+```
+
+---
+
+## Errors
+
+| Exception | Meaning |
+|---|---|
+| `SuperCartoConnectionError` | The server could not start or did not respond. Your problem. |
+| `ToolError` | The tool ran and reported a failure. Usually a real answer, like "traffic is not configured". |
+
+They are deliberately distinct. Conflating them would make a retry loop hammer
+a server that is behaving correctly.
+
+---
+
+## Zero dependencies
+
+This package has no runtime dependencies, on purpose.
+
+The `mcp` SDK pulls in httpx, pydantic, and their transitive trees. An agent
+framework that already depends on any of those should not get a second copy at a
+different version. Three JSON-RPC methods and one line-delimited framing are
+small enough to implement directly, which is what `client.py` does.
+
+The trade: `pip install supercarto` does not bring Node with it. Calling anything
+raises a `SuperCartoConnectionError` that says so, with the fix, in one sentence.
+
+---
+
+## Links
+
+- **npm:** https://www.npmjs.com/package/supercarto
+- **Repository:** https://github.com/supercarto/supercarto
+- **Benchmark:** https://github.com/supercarto/supercarto/blob/main/docs/benchmark.md
+
+Apache-2.0

supercarto-0.3.0/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "supercarto"
+version = "0.3.0"
+description = "LLM-native spatial middleware. Give an AI agent a map of any location on earth as a token-budgeted topological graph, with indoor floors, weather, and traffic."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [{ name = "supercarto contributors" }]
+keywords = [
+    "llm",
+    "agents",
+    "mcp",
+    "geospatial",
+    "gis",
+    "openstreetmap",
+    "topology",
+    "token-efficiency",
+    "indoor-maps",
+    "routing",
+    "weather",
+    "traffic",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Software Development :: Libraries",
+]
+
+# Intentionally zero runtime dependencies.
+#
+# The Python package is a client for the Node MCP server over stdio. It speaks
+# JSON-RPC itself rather than importing the `mcp` SDK, because that SDK pulls in
+# httpx, pydantic, and their transitive trees, and an agent framework that
+# already depends on any of them should not get a second copy.
+#
+# The consequence is that `pip install supercarto` does not require Node. Calling
+# anything raises a clear error telling you to install it. That is a deliberate
+# trade: one subprocess the agent already knows how to spawn, in exchange for an
+# install that cannot conflict with anything.
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "pytest-asyncio>=0.24", "mypy>=1.11", "ruff>=0.6"]
+
+[project.urls]
+Homepage = "https://github.com/supercarto/supercarto"
+Repository = "https://github.com/supercarto/supercarto"
+Issues = "https://github.com/supercarto/supercarto/issues"
+"Benchmark" = "https://github.com/supercarto/supercarto/blob/main/docs/benchmark.md"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/supercarto"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/supercarto", "README.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.mypy]
+python_version = "3.10"
+strict = true

supercarto-0.3.0/src/supercarto/__init__.py

@@ -0,0 +1,49 @@
+"""supercarto - LLM-native spatial middleware for Python.
+
+A thin, dependency-free client for the supercarto MCP server.
+
+The design decision worth knowing about: this package does not reimplement
+anything. The map compilation, the token budgeting, the topology work and the
+indoor graph all live in the Node library, and this speaks JSON-RPC to it over
+stdio. That is deliberate, because those algorithms are the product and a second
+implementation in a second language would be a second thing to keep correct.
+
+So the shape here is: start the server, call a tool, get back text an agent can
+act on.
+
+    import asyncio
+    from supercarto import SuperCarto
+
+    async def main():
+        async with SuperCarto() as carto:
+            m = await carto.maplet(lat=35.6833, lon=139.7620, radius_m=400, budget=1500)
+            print(m.yaml)
+            print(m.tokens, "tokens")
+
+    asyncio.run(main())
+"""
+
+from .client import (
+    ConnectionError as SuperCartoConnectionError,
+    MapletResult,
+    RouteResult,
+    SuperCarto,
+    ToolError,
+    TrafficResult,
+    WeatherResult,
+    default_server_command,
+)
+
+__version__ = "0.3.0"
+
+__all__ = [
+    "MapletResult",
+    "RouteResult",
+    "SuperCarto",
+    "SuperCartoConnectionError",
+    "ToolError",
+    "TrafficResult",
+    "WeatherResult",
+    "default_server_command",
+    "__version__",
+]

supercarto-0.3.0/src/supercarto/client.py

@@ -0,0 +1,593 @@
+"""JSON-RPC client for the supercarto MCP server over stdio.
+
+The protocol is three messages and a Content-Length-framed JSON body. That is
+small enough to implement directly, which is why this package has no runtime
+dependencies: importing an SDK here would force httpx and pydantic onto every
+user, most of whom already have one of them at a different version.
+
+What this module does care about is being honest when the server cannot start.
+A Node binary that is missing is the single most likely failure for a new user,
+and the error says so in one sentence with the fix, rather than surfacing an
+``FileNotFoundError`` from deep inside ``asyncio``.
+"""
+
+from __future__ import annotations
+
+import asyncio
+import json
+import os
+import shutil
+from dataclasses import dataclass, field
+from typing import Any, AsyncIterator, Sequence
+
+__all__ = [
+    "ConnectionError",
+    "MapletResult",
+    "RouteResult",
+    "SuperCarto",
+    "ToolError",
+    "TrafficResult",
+    "WeatherResult",
+    "default_server_command",
+]
+
+# JSON-RPC method names as they appear on the wire.
+_INITIALIZE = "initialize"
+_TOOLS_LIST = "tools/list"
+_TOOLS_CALL = "tools/call"
+_NOTIFICATIONS_INITIALIZED = "notifications/initialized"
+
+
+class ConnectionError(Exception):
+    """The MCP server could not be started or did not respond."""
+
+
+class ToolError(Exception):
+    """A tool ran and reported a failure.
+
+    Kept distinct from :class:`ConnectionError` because the two mean different
+    things to a caller: a connection error is this client's problem, a tool error
+    is usually a real answer about the world, such as "traffic is not configured
+    for this deployment".
+    """
+
+
+@dataclass
+class MapletResult:
+    """A compiled, token-budgeted map graph."""
+
+    yaml: str
+    tokens: int
+    """Tokens the server reported. Always within the requested budget."""
+
+    budget: int
+    fetched_from: str
+    """Which upstream source answered. Useful when a latency is unexpected."""
+
+    warnings: list[str] = field(default_factory=list)
+    """Problems the source reported. A non-empty list means the map is partial."""
+
+
+@dataclass
+class RouteResult:
+    """Turn-by-turn directions as prose."""
+
+    mode: str
+    distance_m: int
+    duration_s: int
+    steps: list[str]
+    source: str
+    free_flow_only: bool = False
+    """True when no traffic source was configured, so the duration ignores
+    congestion. Check this before quoting an arrival time to anyone."""
+
+
+@dataclass
+class WeatherResult:
+    """Current conditions and a short forecast."""
+
+    summary: str
+    temp_c: float | None
+    feels_like_c: float | None
+    precipitation: str
+    wind_kmh: float | None
+    advisory: str
+    degraded: bool = False
+    """True when the forecast source was unreachable. ``temp_c`` is None then,
+    and the advisory says so. Do not read a missing reading as a dry day."""
+
+
+@dataclass
+class TrafficResult:
+    """Congestion and arrival time."""
+
+    level: str
+    worst_level: str
+    duration_s: int
+    free_flow_s: int
+    delay_s: int
+    free_flow_only: bool
+    unavailable: str | None = None
+
+
+def default_server_command() -> list[str]:
+    """How to launch the server when the caller does not say.
+
+    Prefers an already-installed ``supercarto`` on PATH, because that is the
+    normal case after ``npm install -g supercarto``. Falls back to ``npx`` so a
+    user who has only pip-installed the Python package still works, at the cost
+    of a first-call download.
+    """
+    explicit = os.environ.get("SUPERCARTO_SERVER_CMD")
+    if explicit:
+        return explicit.split()
+
+    on_path = shutil.which("supercarto")
+    if on_path:
+        return [on_path, "mcp"]
+
+    if shutil.which("npx"):
+        return ["npx", "-y", "supercarto", "mcp"]
+
+    return ["supercarto", "mcp"]
+
+
+class SuperCarto:
+    """An MCP client for supercarto.
+
+    Use it as an async context manager so the subprocess is always cleaned up::
+
+        async with SuperCarto() as carto:
+            await carto.maplet(lat=51.5, lon=-0.12)
+
+    Or manage ``start`` and ``close`` yourself if the lifetime is awkward to
+    express with ``async with``.
+    """
+
+    def __init__(
+        self,
+        command: Sequence[str] | None = None,
+        *,
+        env: dict[str, str] | None = None,
+        timeout_s: float = 90.0,
+    ) -> None:
+        self._command = list(command) if command else default_server_command()
+        self._env = {**os.environ, **(env or {})}
+        # Generous by default because a first request against the public Overpass
+        # instance genuinely takes 15-40 seconds, and a timeout shorter than
+        # that would fail on correct behaviour.
+        self._timeout_s = timeout_s
+        self._proc: asyncio.subprocess.Process | None = None
+        self._next_id = 1
+        self._tools: list[dict[str, Any]] | None = None
+        self._write_lock = asyncio.Lock()
+
+    async def __aenter__(self) -> SuperCarto:
+        await self.start()
+        return self
+
+    async def __aexit__(self, *exc: object) -> None:
+        await self.close()
+
+    async def start(self) -> None:
+        """Spawn the server and complete the MCP handshake."""
+        try:
+            self._proc = await asyncio.create_subprocess_exec(
+                *self._command,
+                stdin=asyncio.subprocess.PIPE,
+                stdout=asyncio.subprocess.PIPE,
+                stderr=asyncio.subprocess.DEVNULL,
+                env=self._env,
+            )
+        except FileNotFoundError as exc:
+            # The one error every new user hits, so it gets the one error worth
+            # writing well.
+            raise ConnectionError(
+                f"could not run {' '.join(self._command)!r}: command not found.\n"
+                "supercarto is a Node program. Install it with:\n"
+                "  npm install -g supercarto\n"
+                "or set SUPERCARTO_SERVER_CMD to its full path."
+            ) from exc
+
+        await self._request(
+            _INITIALIZE,
+            {
+                "protocolVersion": "2024-11-05",
+                "capabilities": {},
+                "clientInfo": {"name": "supercarto-python", "version": "0.3.0"},
+            },
+        )
+        await self._notify(_NOTIFICATIONS_INITIALIZED, {})
+
+    async def close(self) -> None:
+        """Terminate the server."""
+        if self._proc is None:
+            return
+        if self._proc.returncode is None:
+            self._proc.terminate()
+            try:
+                # A short grace period before SIGKILL, so the server can close
+                # its own handles instead of being cut off mid-write.
+                await asyncio.wait_for(self._proc.wait(), timeout=5)
+            except asyncio.TimeoutError:
+                self._proc.kill()
+                await self._proc.wait()
+        self._proc = None
+        self._tools = None
+
+    async def tools(self) -> list[str]:
+        """Tool names this deployment actually offers.
+
+        Worth checking before a loop: ``get_traffic`` is absent unless a flow
+        credential is configured, and calling it anyway raises rather than
+        returning a plausible free-flow estimate.
+        """
+        if self._tools is None:
+            result = await self._request(_TOOLS_LIST, {})
+            self._tools = list(result.get("tools", []))
+        return [t["name"] for t in self._tools if "name" in t]
+
+    async def maplet(
+        self,
+        lat: float,
+        lon: float,
+        radius_m: int = 300,
+        budget: int = 1024,
+        layers: list[str] | None = None,
+    ) -> MapletResult:
+        """Fetch a map around a coordinate and compile it for an agent.
+
+        The budget is honoured: the server measures its own output and cuts until
+        it fits, so ``tokens`` will not exceed ``budget``.
+        """
+        args: dict[str, Any] = {"lat": lat, "lon": lon, "radiusM": radius_m, "budget": budget}
+        if layers:
+            args["layers"] = layers
+
+        text = await self._call("get_maplet", args)
+        return _parse_maplet(text, budget)
+
+    async def route(
+        self,
+        from_lat: float,
+        from_lon: float,
+        to_lat: float,
+        to_lon: float,
+        mode: str = "walk",
+    ) -> RouteResult:
+        """Turn-by-turn directions as prose, which a model reads better than geometry."""
+        text = await self._call(
+            "route",
+            {
+                "fromLat": from_lat,
+                "fromLon": from_lon,
+                "toLat": to_lat,
+                "toLon": to_lon,
+                "mode": mode,
+            },
+        )
+        return _parse_route(text)
+
+    async def search_places(
+        self,
+        lat: float,
+        lon: float,
+        radius_m: int = 300,
+        query: str | None = None,
+        limit: int = 20,
+    ) -> list[str]:
+        """Find named places near a coordinate. Cheaper than :meth:`maplet`."""
+        args: dict[str, Any] = {"lat": lat, "lon": lon, "radiusM": radius_m, "limit": limit}
+        if query:
+            args["query"] = query
+        text = await self._call("search_places", args)
+        return [line[2:].strip() for line in text.splitlines() if line.startswith("- ")]
+
+    async def weather(self, lat: float, lon: float, hours: int = 12) -> WeatherResult:
+        """Current conditions and forecast. Needs no API key.
+
+        Raises :class:`ToolError` if the forecast source is unreachable, rather
+        than returning a result that reads as a dry day.
+        """
+        text = await self._call("get_weather", {"lat": lat, "lon": lon, "hours": hours})
+        return _parse_weather(text)
+
+    async def traffic(
+        self, from_lat: float, from_lon: float, to_lat: float, to_lon: float
+    ) -> TrafficResult:
+        """Congestion and arrival time.
+
+        Raises :class:`ToolError` when no flow source is configured, because a
+        free-flow number returned as if it were live is the failure this library
+        exists to avoid.
+        """
+        text = await self._call(
+            "get_traffic",
+            {"fromLat": from_lat, "fromLon": from_lon, "toLat": to_lat, "toLon": to_lon},
+        )
+        return _parse_traffic(text)
+
+    async def _call(self, name: str, args: dict[str, Any]) -> str:
+        result = await self._request(_TOOLS_CALL, {"name": name, "arguments": args})
+        if result.get("isError"):
+            raise ToolError(_content_text(result) or f"{name} failed")
+
+        text = _content_text(result)
+        if not text:
+            raise ToolError(f"{name} returned no content")
+        return text
+
+    async def _request(self, method: str, params: dict[str, Any]) -> dict[str, Any]:
+        if self._proc is None or self._proc.stdin is None:
+            raise ConnectionError("server not started; call start() or use `async with`")
+
+        self._next_id += 1
+        request_id = self._next_id
+        payload = {"jsonrpc": "2.0", "id": request_id, "method": method, "params": params}
+        await self._write(payload)
+
+        # A timeout is not paranoia. A framing mismatch between client and server
+        # manifests as the server never answering at all, so without this the
+        # failure mode is an indefinite hang rather than an error message.
+        try:
+            deadline = asyncio.wait_for(
+                self._await_response(request_id), timeout=self._timeout_s
+            )
+            return await deadline
+        except asyncio.TimeoutError as exc:
+            raise ConnectionError(
+                f"no response to {method} after {self._timeout_s:g}s. "
+                "If this is a map request the upstream data source may be slow; "
+                "otherwise the client and server disagree about framing."
+            ) from exc
+
+    async def _await_response(self, request_id: int) -> dict[str, Any]:
+        while True:
+            message = await self._read_message()
+            # Skip anything that is not our response: the server is free to send
+            # notifications, and a log line on stdout would otherwise look like a
+            # reply.
+            if message.get("id") != request_id:
+                if "error" in message and message.get("id") is None:
+                    raise ConnectionError(f"server error: {message['error']}")
+                continue
+            if "error" in message:
+                raise ConnectionError(f"{method} failed: {message['error']}")
+            result = message.get("result", {})
+            return result if isinstance(result, dict) else {}
+
+    async def _notify(self, method: str, params: dict[str, Any]) -> None:
+        await self._write({"jsonrpc": "2.0", "method": method, "params": params})
+
+    async def _write(self, payload: dict[str, Any]) -> None:
+        """Send one newline-delimited JSON message.
+
+        Newline framing rather than Content-Length headers. supercarto's server
+        writes `JSON.stringify(...) + "\\n"`, which is the simpler of the two
+        framings the MCP spec allows and the one this client has to match:
+        sending a Content-Length header to a newline reader hangs on the first
+        request, because the server treats the header line as a malformed message
+        and answers nothing.
+        """
+        if self._proc is None or self._proc.stdin is None:
+            raise ConnectionError("server not started; call start() or use `async with`")
+        # Serialised because stdin is a single stream: two interleaved writes
+        # would corrupt the line framing.
+        async with self._write_lock:
+            self._proc.stdin.write((json.dumps(payload, separators=(",", ":")) + "\n").encode())
+            await self._proc.stdin.drain()
+
+    async def _read_message(self) -> dict[str, Any]:
+        if self._proc is None or self._proc.stdout is None:
+            raise ConnectionError("server not started")
+
+        while True:
+            line = await self._proc.stdout.readline()
+            if not line:
+                code = self._proc.returncode
+                raise ConnectionError(f"server closed its output (exit code {code})")
+            text = line.decode().strip()
+            if text == "":
+                continue
+            try:
+                parsed = json.loads(text)
+            except json.JSONDecodeError as exc:
+                # Anything that is not JSON on stdout is a stray print. Skipping
+                # it is better than dying, since a log line from a dependency
+                # should not take down a working session.
+                continue
+            if isinstance(parsed, dict):
+                return parsed
+
+
+def _content_text(result: dict[str, Any]) -> str:
+    content = result.get("content")
+    if not isinstance(content, list):
+        return ""
+    return "\n".join(
+        block.get("text", "") for block in content if isinstance(block, dict)
+    ).strip()
+
+
+# ---------------------------------------------------------------------------
+# Response parsing
+#
+# The MCP server returns text meant for a language model, so this parses prose
+# rather than reading structured fields. That is a deliberate choice at both
+# ends: the server emits prose because a model reads it better than a JSON blob,
+# and this client parses it back with narrow patterns. Both halves are pinned by
+# tests, so a change to the wording on one side fails loudly rather than
+# silently returning None.
+# ---------------------------------------------------------------------------
+
+
+def _parse_maplet(text: str, budget: int) -> MapletResult:
+    header, sep, body = text.partition("\n\n")
+    # With no header at all, `partition` swallows the whole document as the
+    # header and returns an empty body. Detecting that case keeps a caller from
+    # receiving an empty map from a server that actually answered.
+    if not sep:
+        header, body = "", text
+
+    fetched_from = "unknown"
+    tokens = 0
+    warnings: list[str] = []
+
+    for line in header.splitlines():
+        if line.startswith("# maplet @"):
+            # The header carries the centre and the source in parentheses.
+            # Taking the last "(" group avoids splitting on the coordinate.
+            _, _, rest = line.partition("@")
+            tail = rest.strip()
+            _, _, trailing = tail.rpartition("(")
+            fetched_from = trailing.rstrip(")").strip() or tail
+        elif line.startswith("# tokens "):
+            # "tokens 749/1500  nodes 19  edges 34"
+            token_part = line.removeprefix("# tokens ").split()[0]
+            tokens = int(token_part.split("/")[0] or 0)
+        elif line.startswith("# WARNING: "):
+            warnings.append(line.removeprefix("# WARNING: "))
+
+    return MapletResult(
+        yaml=body,
+        tokens=tokens,
+        budget=budget,
+        fetched_from=fetched_from,
+        warnings=warnings,
+    )
+
+
+def _parse_route(text: str) -> RouteResult:
+    mode = "walk"
+    distance = 0
+    duration = 0
+    source = "unknown"
+    steps: list[str] = []
+    free_flow_only = False
+
+    for line in text.splitlines():
+        if line.startswith("route ("):
+            # "route (walk) via osrm" carries both the mode and the source.
+            inner = line.removeprefix("route (").rstrip(")")
+            mode_part, _, source_part = inner.partition(") via ")
+            mode = mode_part.split()[0] if mode_part.split() else "walk"
+            source = source_part.strip() or source
+        elif line.startswith("total: "):
+            for part in line.removeprefix("total: ").split(", "):
+                value = part.split("m")[0].split("s")[0].strip()
+                if part.endswith("m"):
+                    distance = int(value)
+                elif part.endswith("s"):
+                    duration = int(value)
+        elif line[:1].isdigit() and "." in line:
+            steps.append(line.strip())
+
+    return RouteResult(
+        mode=mode,
+        distance_m=distance,
+        duration_s=duration,
+        steps=steps,
+        source=source,
+        free_flow_only=free_flow_only,
+    )
+
+
+def _parse_weather(text: str) -> WeatherResult:
+    summary = "unknown"
+    temp: float | None = None
+    feels: float | None = None
+    precipitation = "unknown"
+    wind: float | None = None
+    advisory = ""
+
+    for line in text.splitlines():
+        if line.startswith("now: "):
+            body = line.removeprefix("now: ")
+            summary = body.split(",")[0].strip()
+            temp = _first_float(body)
+            feels = _nth_float(body, 1)
+            wind = _nth_float(body, 2)
+        elif line.startswith("precipitation: "):
+            value = line.removeprefix("precipitation: ").split(",")[0].strip()
+            precipitation = value.split()[0] or "unknown"
+        elif line.startswith("advisory: "):
+            advisory = line.removeprefix("advisory: ")
+
+    return WeatherResult(
+        summary=summary,
+        temp_c=temp,
+        feels_like_c=feels,
+        precipitation=precipitation,
+        wind_kmh=wind,
+        advisory=advisory,
+    )
+
+
+def _parse_traffic(text: str) -> TrafficResult:
+    free_flow_only = "unknown" in text.splitlines()[0] if text else False
+    level = "unknown"
+    worst = "unknown"
+    duration = 0
+    free_flow = 0
+    delay = 0
+    unavailable = None
+
+    for line in text.splitlines():
+        if line.startswith("traffic: "):
+            level = line.removeprefix("traffic: ").split(" ")[0].strip()
+            if "worst segment" in line:
+                worst = line.split("worst segment ")[1].strip()
+        elif line.startswith("traffic "):
+            parts = line.split()
+            level = parts[1] if len(parts) > 1 else level
+            if "worst segment" in line:
+                worst = line.split("worst segment ")[1].strip()
+        elif line.startswith("free-flow estimate: "):
+            free_flow = _first_int(line)
+        elif line.startswith("duration: "):
+            body = line.removeprefix("duration: ")
+            duration = _first_int(body)
+            # "1500s including 900s of delay (free flow would be 600s)".
+            # Splitting on " including " rather than " of " avoids catching the
+            # "(free flow would be 600s)" tail, which is a different number.
+            if " including " in body:
+                delay = _first_int(body.split(" including ")[1])
+        elif line.startswith("note: "):
+            unavailable = line.removeprefix("note: ")
+
+    return TrafficResult(
+        level=level,
+        worst_level=worst,
+        duration_s=duration,
+        free_flow_s=free_flow or duration,
+        delay_s=delay,
+        free_flow_only=free_flow_only,
+        unavailable=unavailable,
+    )
+
+
+def _first_float(text: str) -> float | None:
+    return _nth_float(text, 0)
+
+
+def _nth_float(text: str, index: int) -> float | None:
+    """The index-th number in a string, or None.
+
+    Numbers are found with a strict pattern so the "C" in a temperature unit
+    does not count as part of a value and a street number in a name does not
+    shift the index.
+    """
+    import re
+
+    found = re.findall(r"-?\d+(?:\.\d+)?", text)
+    if index < len(found):
+        try:
+            return float(found[index])
+        except ValueError:
+            return None
+    return None
+
+
+def _first_int(text: str) -> int:
+    value = _nth_float(text, 0)
+    return int(value) if value is not None else 0