docs-and-mcps (#1)

Reviewed-on: #1 Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com> Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
2026-01-22 11:28:23 +00:00
parent 3636e6edc8
commit f7f9744e47
53 changed files with 5759 additions and 234 deletions
--- a/mcp_docs/modules/mail_intake.auth.base.json
+++ b/mcp_docs/modules/mail_intake.auth.base.json
@@ -0,0 +1,60 @@
+{
+  "module": "mail_intake.auth.base",
+  "content": {
+    "path": "mail_intake.auth.base",
+    "docstring": "Authentication provider contracts for Mail Intake.\n\nThis module defines the **authentication abstraction layer** used by mail\nadapters to obtain provider-specific credentials.\n\nAuthentication concerns are intentionally decoupled from adapter logic.\nAdapters depend only on this interface and must not be aware of how\ncredentials are acquired, refreshed, or persisted.",
+    "objects": {
+      "ABC": {
+        "name": "ABC",
+        "kind": "alias",
+        "path": "mail_intake.auth.base.ABC",
+        "signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
+        "docstring": null
+      },
+      "abstractmethod": {
+        "name": "abstractmethod",
+        "kind": "alias",
+        "path": "mail_intake.auth.base.abstractmethod",
+        "signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
+        "docstring": null
+      },
+      "Generic": {
+        "name": "Generic",
+        "kind": "alias",
+        "path": "mail_intake.auth.base.Generic",
+        "signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
+        "docstring": null
+      },
+      "TypeVar": {
+        "name": "TypeVar",
+        "kind": "alias",
+        "path": "mail_intake.auth.base.TypeVar",
+        "signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
+        "docstring": null
+      },
+      "T": {
+        "name": "T",
+        "kind": "attribute",
+        "path": "mail_intake.auth.base.T",
+        "signature": null,
+        "docstring": null
+      },
+      "MailIntakeAuthProvider": {
+        "name": "MailIntakeAuthProvider",
+        "kind": "class",
+        "path": "mail_intake.auth.base.MailIntakeAuthProvider",
+        "signature": "<bound method Class.signature of Class('MailIntakeAuthProvider', 18, 59)>",
+        "docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nAuthentication providers encapsulate all logic required to:\n- Acquire credentials from an external provider\n- Refresh or revalidate credentials as needed\n- Handle authentication-specific failure modes\n- Coordinate with credential persistence layers where applicable\n\nMail adapters must treat returned credentials as opaque and\nprovider-specific, relying only on the declared credential type\nexpected by the adapter.",
+        "members": {
+          "get_credentials": {
+            "name": "get_credentials",
+            "kind": "function",
+            "path": "mail_intake.auth.base.MailIntakeAuthProvider.get_credentials",
+            "signature": "<bound method Function.signature of Function('get_credentials', 37, 59)>",
+            "docstring": "Retrieve valid, provider-specific credentials.\n\nThis method is synchronous by design and represents the sole\nentry point through which adapters obtain authentication\nmaterial.\n\nImplementations must either return credentials of the declared\ntype ``T`` that are valid at the time of return or raise an\nauthentication-specific exception.\n\nReturns:\n    Credentials of type ``T`` suitable for immediate use by the\n    corresponding mail adapter.\n\nRaises:\n    Exception:\n        An authentication-specific exception indicating that\n        credentials could not be obtained or validated."
+          }
+        }
+      }
+    }
+  }
+}