@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/report-spec.js

@@ -0,0 +1,27 @@
+import { fileURLToPath } from "node:url";
+import { dirname } from "node:path";
+import { createCatalogStore } from "@nightsquawktech/mcp-core/catalog";
+// Path resolution stays HERE, in the server, so it points at this server's
+// bundled catalog (dist/catalog) and not at the mcp-core package. The core
+// loader receives the resolved directory and never derives it from its own
+// module location. Report entries live under ./reports/, not the store's
+// default ./endpoints/.
+const catalogDir = dirname(fileURLToPath(import.meta.url)); // dist/catalog
+const store = createCatalogStore(catalogDir, { entriesSubdir: "reports" });
+/** The aggregate catalog index (slug, name, category, requiredFilters per report). */
+export function loadIndex() {
+    return store.index();
+}
+/** Pagination params allowed on every report regardless of endpoint. */
+export function universalParameters() {
+    return loadIndex().universalParameters;
+}
+/** Full spec for a single report, or null if the slug is unknown. */
+export function loadReportSpec(slug) {
+    // Entries live under reports/; the core store guards against path traversal.
+    return store.entry(slug);
+}
+/** True if the slug names a real report endpoint. */
+export function isKnownReport(slug) {
+    return loadIndex().reports.some((r) => r.slug === slug);
+}

package/dist/catalog/reports/account_totals.json

@@ -0,0 +1,112 @@
+{
+  "slug": "account_totals",
+  "endpoint": "account_totals.json",
+  "name": "Account Totals",
+  "description": "Returns Account Totals report data.",
+  "requiredFilters": [
+    "gl_account_ids",
+    "posted_on_from",
+    "posted_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "string",
+      "required": true,
+      "description": "The gl account id to filter by."
+    },
+    {
+      "name": "posted_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "posted_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "gl_account_ids": "1",
+    "posted_on_from": "2023-06-01",
+    "posted_on_to": "2023-06-30",
+    "accounting_basis": "Cash",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/additional_fees.json

@@ -0,0 +1,73 @@
+{
+  "slug": "additional_fees",
+  "endpoint": "additional_fees.json",
+  "name": "Additional Fees",
+  "description": "Returns Additional Fees report data.",
+  "requiredFilters": [],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/aged_payables_summary.json

@@ -0,0 +1,124 @@
+{
+  "slug": "aged_payables_summary",
+  "endpoint": "aged_payables_summary.json",
+  "name": "Aged Payables Summary",
+  "description": "Returns Aged Payables Summary report data.",
+  "requiredFilters": [
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'As of To' date to filter by."
+    },
+    {
+      "name": "party_contact_info",
+      "type": "object",
+      "required": false,
+      "description": "The Payee filter. Expand to view all attributes associated with this filter. You can only submit ONE of the below filters.",
+      "attributes": [
+        {
+          "name": "company_id",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "balance_operator",
+      "type": "object",
+      "required": false,
+      "description": "The Balance to filter by. Expand to view all attributes associated with this filter.",
+      "attributes": [
+        {
+          "name": "amount",
+          "type": "string",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "comparator",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "occurred_on_to": "2023-06-30",
+    "party_contact_info": {
+      "company_id": "1"
+    },
+    "balance_operator": {
+      "amount": "100",
+      "comparator": "="
+    },
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/aged_receivables_detail.json

@@ -0,0 +1,132 @@
+{
+  "slug": "aged_receivables_detail",
+  "endpoint": "aged_receivables_detail.json",
+  "name": "Aged Receivable Detail",
+  "description": "Returns Aged Receivable Detail report data.",
+  "requiredFilters": [
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "tags",
+      "type": "string",
+      "required": false,
+      "description": "The comma-separated tag(s) to filter by"
+    },
+    {
+      "name": "balance_operator",
+      "type": "object",
+      "required": false,
+      "description": "The Amount Receivable to filter by. Expand to view all attributes associated with this filter.",
+      "attributes": [
+        {
+          "name": "amount",
+          "type": "string",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "comparator",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "tenant_statuses",
+      "type": "array",
+      "required": false,
+      "default": "[\"0\",\"4\"]",
+      "enum": [
+        "'2' denotes 'Future'",
+        "'0' denotes 'Current'",
+        "'4' denotes 'Notice'",
+        "'1' denotes 'Past'",
+        "'3' denotes 'Evict'"
+      ],
+      "description": "List of Tenant status to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'As of To' date to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "tags": "bbq,deck",
+    "balance_operator": {
+      "amount": "100",
+      "comparator": "="
+    },
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "occurred_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/amenities_by_property.json

@@ -0,0 +1,73 @@
+{
+  "slug": "amenities_by_property",
+  "endpoint": "amenities_by_property.json",
+  "name": "Amenities By Property",
+  "description": "Returns Amenities By Property report data.",
+  "requiredFilters": [],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/annual_budget_comparative.json

@@ -0,0 +1,138 @@
+{
+  "slug": "annual_budget_comparative",
+  "endpoint": "annual_budget_comparative.json",
+  "name": "Annual Budget - Comparative",
+  "description": "Returns Annual Budget - Comparative report data.",
+  "requiredFilters": [
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM",
+      "description": "The 'As of' month to filter by."
+    },
+    {
+      "name": "additional_account_types",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "enum": [
+        "Asset",
+        "Cash",
+        "Liability",
+        "Capital"
+      ],
+      "description": "Additional account types to filter by."
+    },
+    {
+      "name": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual",
+        "Modified Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "level_of_detail",
+      "type": "string",
+      "required": false,
+      "default": "detail_view",
+      "enum": [
+        "detail_view",
+        "summary_view"
+      ],
+      "description": "The level of detail to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "occurred_on_to": "2023-06",
+    "additional_account_types": [
+      "Asset"
+    ],
+    "accounting_basis": "Cash",
+    "level_of_detail": "detail_view",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "account_name",
+    "mtd_actual",
+    "mtd_budget",
+    "mtd_amount_variance",
+    "mtd_percent_variance",
+    "ytd_actual",
+    "ytd_budget",
+    "ytd_amount_variance",
+    "ytd_percent_variance",
+    "annual",
+    "account_number",
+    "note",
+    "variance_note"
+  ]
+}