gravity-schema 0.1.0__py3-none-any.whl

gravity_schema/__init__.py

@@ -0,0 +1,88 @@
+"""Gravity agent manifest contract: its shape, validation and JSON Schema export."""
+
+from .catalog import DEV_TOOL_NAMES, StaticToolCatalog, ToolCatalog, dev_catalog
+from .contract import (
+    AGENT_NAME_RE,
+    CURRENT_CONTRACT_VERSION,
+    ENV_GATEWAY_URL,
+    ENV_LLM_URL,
+    ENV_RUN_TOKEN,
+    LOCKFILE_PLATFORM,
+    SUPPORTED_CONTRACT_VERSIONS,
+    SUPPORTED_PYTHON_VERSIONS,
+)
+from .errors import (
+    ErrorCode,
+    ManifestIssue,
+    ManifestValidationError,
+    Severity,
+    did_you_mean,
+    suggest,
+)
+from .export import manifest_json_schema
+from .manifest import (
+    ApprovalsSpec,
+    DependenciesSpec,
+    InputSpec,
+    InputType,
+    Manifest,
+    ModelsSpec,
+    ModelTier,
+    PermissionsSpec,
+    ResourcesSpec,
+    RuntimeSpec,
+    ScheduleSpec,
+    StateSpec,
+    TriggersSpec,
+)
+from .validation import (
+    check_tool_references,
+    load_manifest_file,
+    load_manifest_text,
+    validate_manifest,
+)
+
+__all__ = [  # noqa: RUF022 - grouped by concern, not alphabetical
+    # contract
+    "CURRENT_CONTRACT_VERSION",
+    "AGENT_NAME_RE",
+    "SUPPORTED_CONTRACT_VERSIONS",
+    "SUPPORTED_PYTHON_VERSIONS",
+    "LOCKFILE_PLATFORM",
+    "ENV_GATEWAY_URL",
+    "ENV_LLM_URL",
+    "ENV_RUN_TOKEN",
+    # models
+    "Manifest",
+    "RuntimeSpec",
+    "DependenciesSpec",
+    "InputSpec",
+    "InputType",
+    "PermissionsSpec",
+    "ModelsSpec",
+    "ModelTier",
+    "ResourcesSpec",
+    "TriggersSpec",
+    "ScheduleSpec",
+    "ApprovalsSpec",
+    "StateSpec",
+    # validation
+    "validate_manifest",
+    "load_manifest_text",
+    "load_manifest_file",
+    "check_tool_references",
+    # catalog
+    "ToolCatalog",
+    "StaticToolCatalog",
+    "dev_catalog",
+    "DEV_TOOL_NAMES",
+    # errors
+    "ErrorCode",
+    "Severity",
+    "ManifestIssue",
+    "ManifestValidationError",
+    "suggest",
+    "did_you_mean",
+    # export
+    "manifest_json_schema",
+]

gravity_schema/__main__.py

@@ -0,0 +1,6 @@
+"""`python -m gravity_schema`: the schema exporter, without the runpy warning `-m gravity_schema.export` prints."""
+
+from .export import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

gravity_schema/catalog.py

@@ -0,0 +1,93 @@
+"""The tool catalog, read from catalog.yaml. Validation takes any ToolCatalog: the control
+plane's live one in production, dev_catalog() locally."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Protocol
+
+import yaml
+
+
+class ToolCatalog(Protocol):
+    def exists(self, tool_name: str) -> bool: ...
+
+    def names(self) -> frozenset[str]: ...
+
+
+class StaticToolCatalog:
+    """A catalog backed by a fixed set of names."""
+
+    def __init__(self, names: Iterable[str]) -> None:
+        self._names = frozenset(names)
+
+    def exists(self, tool_name: str) -> bool:
+        return tool_name in self._names
+
+    def names(self) -> frozenset[str]:
+        return self._names
+
+
+@dataclass(frozen=True)
+class ToolEntry:
+    name: str
+    slug: str | None  # None: built into the gateway, no vendor behind it
+    description: str
+    scopes: tuple[str, ...]
+    breadth: str  # generic | niche
+    guarantee: str  # certified | community | experimental
+    side_effect: str  # read | write
+
+
+_BREADTH = {"generic", "niche"}
+_GUARANTEE = {"certified", "community", "experimental"}
+_SIDE_EFFECT = {"read", "write"}
+
+
+def load_catalog(path: Path | None = None) -> tuple[ToolEntry, ...]:
+    """Parse and check catalog.yaml; a malformed entry fails at import."""
+    raw = yaml.safe_load((path or Path(__file__).with_name("catalog.yaml")).read_text(encoding="utf-8"))
+    # catalog_imported.yaml (`gravity-gateway sync-tools`): the same apps' other tools,
+    # experimental. Absent until the first sync; never read for an explicit path.
+    imported = Path(__file__).with_name("catalog_imported.yaml")
+    if path is None and imported.is_file():
+        raw = [*raw, *(yaml.safe_load(imported.read_text(encoding="utf-8")) or [])]
+    entries: list[ToolEntry] = []
+    for item in raw:
+        entry = ToolEntry(
+            name=item["name"],
+            slug=item.get("slug"),
+            description=item["description"],
+            scopes=tuple(item.get("scopes") or ()),
+            breadth=item["breadth"],
+            guarantee=item["guarantee"],
+            side_effect=item["side_effect"],
+        )
+        problems = []
+        if entry.breadth not in _BREADTH:
+            problems.append(f"breadth {entry.breadth!r}")
+        if entry.guarantee not in _GUARANTEE:
+            problems.append(f"guarantee {entry.guarantee!r}")
+        if entry.side_effect not in _SIDE_EFFECT:
+            problems.append(f"side_effect {entry.side_effect!r}")
+        if problems:
+            raise ValueError(f"catalog.yaml: {entry.name}: bad {', '.join(problems)}")
+        entries.append(entry)
+    names = [e.name for e in entries]
+    dupes = sorted({n for n in names if names.count(n) > 1})
+    if dupes:
+        raise ValueError(f"catalog.yaml: duplicate tool(s): {', '.join(dupes)}")
+    return tuple(entries)
+
+
+# Read once, at import.
+CATALOG: tuple[ToolEntry, ...] = load_catalog()
+
+# What `gravity validate` accepts.
+DEV_TOOL_NAMES: frozenset[str] = frozenset(e.name for e in CATALOG)
+
+
+def dev_catalog() -> StaticToolCatalog:
+    return StaticToolCatalog(DEV_TOOL_NAMES)

gravity_schema/catalog.yaml

@@ -0,0 +1,221 @@
+# The tool catalog: the ONE place a tool is declared.
+#
+# gravity_schema.catalog reads it (CATALOG, DEV_TOOL_NAMES); the platform's
+# gateway slug table and control-plane list are generated from CATALOG there.
+#
+# Adding a tool is adding an entry here and regenerating on the platform side. Removing one is
+# never done: a published manifest is frozen, so a name must keep meaning the
+# same thing forever. Deprecate instead.
+#
+# Fields
+#   name         the Gravity name builders write in permissions.tools
+#   slug         the vendor action it routes to; null for a gateway built-in
+#   description  what a builder or a model reads to choose it
+#   scopes       the consent a consumer grants when connecting
+#   breadth      generic: ordinary plumbing any agent might use
+#                niche:   custom-written for a narrow job; ranked apart in search
+#   guarantee    certified:    Gravity maintains it and it may run hosted
+#                community:    third party, reviewed
+#                experimental: may change; never runs hosted
+#   side_effect  read | write. A write is what approvals are for.
+
+- name: example.echo
+  slug: null
+  description: echoes back its input, for templates and plumbing tests
+  scopes: []
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: gmail.read
+  slug: GMAIL_FETCH_EMAILS
+  description: read the connected Gmail inbox
+  scopes: [gmail.readonly]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: gmail.draft
+  slug: GMAIL_CREATE_EMAIL_DRAFT
+  description: create a Gmail draft
+  scopes: [gmail.compose]
+  breadth: generic
+  guarantee: certified
+  side_effect: write
+
+- name: gmail.send
+  slug: GMAIL_SEND_EMAIL
+  description: send an email from the connected Gmail
+  scopes: [gmail.send]
+  breadth: generic
+  guarantee: certified
+  side_effect: write
+
+- name: sheets.read
+  slug: GOOGLESHEETS_BATCH_GET
+  description: read values from a connected Google Sheet
+  scopes: [sheets]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: sheets.append
+  slug: GOOGLESHEETS_BATCH_UPDATE
+  description: append a row to a connected Google Sheet
+  scopes: [sheets]
+  breadth: generic
+  guarantee: certified
+  side_effect: write
+
+- name: slack.send
+  slug: SLACK_SEND_MESSAGE
+  description: post a message to a connected Slack channel
+  scopes: [slack.chat:write]
+  breadth: generic
+  guarantee: certified
+  side_effect: write
+
+- name: slack.list_channels
+  slug: SLACK_LIST_ALL_CHANNELS
+  description: list channels in the connected Slack workspace
+  scopes: [slack.channels:read]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: slack.read_history
+  slug: SLACK_FETCH_CONVERSATION_HISTORY
+  description: read message history of a Slack channel
+  scopes: [slack.channels:history]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: slack.find_user
+  slug: SLACK_FIND_USERS
+  description: find a Slack user by name, handle or email, for mentions
+  scopes: [slack.users:read]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: calendar.read
+  slug: GOOGLECALENDAR_EVENTS_LIST
+  description: list events on the connected Google Calendar
+  scopes: [calendar.readonly]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: drive.read
+  slug: GOOGLEDRIVE_DOWNLOAD_FILE
+  description: download a file from the connected Google Drive
+  scopes: [drive.readonly]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: linear.create_issue
+  slug: LINEAR_CREATE_LINEAR_ISSUE
+  description: create an issue in a connected Linear team
+  scopes: [linear.write]
+  breadth: generic
+  guarantee: certified
+  side_effect: write
+
+- name: linear.list_teams
+  slug: LINEAR_LIST_LINEAR_TEAMS
+  description: list the connected Linear workspace teams
+  scopes: [linear.read]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: linear.list_issues
+  slug: LINEAR_LIST_LINEAR_ISSUES
+  description: list open issues in the connected Linear workspace
+  scopes: [linear.read]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: linear.get_issue
+  slug: LINEAR_GET_LINEAR_ISSUE
+  description: read one Linear issue by id
+  scopes: [linear.read]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+# GitHub: read-only, for change summaries and contribution profiles.
+- name: github.list_commits
+  slug: GITHUB_LIST_COMMITS
+  description: list commits on a repository branch, filterable by date range, author or path
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.get_commit
+  slug: GITHUB_GET_A_COMMIT
+  description: read one commit with its changed files, line counts and patches
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.compare
+  slug: GITHUB_COMPARE_TWO_COMMITS
+  description: compare two refs (base...head) with the commits and changed files between them
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.list_pull_requests
+  slug: GITHUB_LIST_PULL_REQUESTS
+  description: list pull requests on a repository, filterable by state and branch
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.list_pr_files
+  slug: GITHUB_LIST_PULL_REQUESTS_FILES
+  description: list the files a pull request changes, with line counts and patches
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.list_pr_reviews
+  slug: GITHUB_LIST_REVIEWS_FOR_A_PULL_REQUEST
+  description: list the reviews submitted on a pull request
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: github.search_issues
+  slug: GITHUB_SEARCH_ISSUES_AND_PULL_REQUESTS
+  description: search issues and pull requests with GitHub qualifiers (repo:, author:, reviewed-by:, is:pr, created:)
+  scopes: [repo]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: linkedin.whoami
+  slug: LINKEDIN_GET_MY_INFO
+  description: read the connected LinkedIn member's id, name and headline (the author of their posts)
+  scopes: [linkedin.profile]
+  breadth: generic
+  guarantee: certified
+  side_effect: read
+
+- name: linkedin.create_post
+  slug: LINKEDIN_CREATE_LINKED_IN_POST
+  description: publish a post on LinkedIn as the connected member or an organisation they manage
+  scopes: [linkedin.w_member_social]
+  breadth: generic
+  guarantee: certified
+  side_effect: write