Skip to content

Commit 9c54ba9

Browse files
committed
feat: add some XDMoD data
1 parent 51d3a63 commit 9c54ba9

File tree

6 files changed

+950
-10
lines changed

6 files changed

+950
-10
lines changed

data-sources/xdmod.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ id: xdmod
33
name: XDMoD Metrics
44
description: HPC metrics, usage analytics, and resource specifications from the ACCESS XDMoD instance
55
category: Metrics & Reporting
6-
track: Operations
7-
responsible_team: Operations
6+
track: Metrics
7+
responsible_team: Metrics
88
access_level: Varies
99
is_canonical: true
1010
api_endpoint: https://xdmod.access-ci.org/controllers/user_interface.php
@@ -26,14 +26,34 @@ mcp:
2626
description: Get filter values for a dimension (e.g., all resources, institutions)
2727
- name: get_chart_data
2828
method: POST
29-
description: Get chart data and metadata for a statistic
29+
description: Get chart data and metadata for a statistic with optional filters
3030
- name: get_chart_image
3131
method: POST
3232
description: Get chart as SVG, PNG, or PDF image
3333
- name: get_chart_link
3434
method: GET
3535
description: Generate a URL to the interactive XDMoD portal chart
3636

37+
mcp_authenticated:
38+
available: true
39+
package: "@access-mcp/xdmod-data"
40+
notes: Authenticated access via XDMoD API token (xdmod-data Python package). Required for per-user data queries.
41+
tools:
42+
- name: get_user_data
43+
description: Get user-specific usage data by exact user identifier
44+
- name: get_raw_data
45+
description: Extract XDMoD metrics with complex filtering, timeseries/aggregate modes
46+
- name: describe_fields
47+
description: Discover dimensions and metrics in a specific realm
48+
- name: describe_realms
49+
description: List all available XDMoD data realms with capabilities
50+
- name: get_smart_filters
51+
description: Discover filter values for use with get_raw_data (resources, queues, institutions)
52+
- name: get_analysis_template
53+
description: Get pre-configured analysis patterns (14 templates for common scenarios)
54+
- name: integrate_nsf_xdmod
55+
description: Correlate NSF funding data with XDMoD computational usage patterns
56+
3757
use_cases:
3858
- How much CPU time was used across ACCESS last quarter?
3959
- Which resources have the highest GPU utilization?
@@ -393,9 +413,9 @@ notes:
393413

394414
XDMoD (XD Metrics on Demand) provides comprehensive metrics on ACCESS cyberinfrastructure usage. It covers 9 realms of data from job accounting (Jobs), detailed performance monitoring (SUPREMM), cloud compute (Cloud), gateway usage (Gateways), allocation tracking (Allocations), user accounts (Accounts), allocation requests (Requests), resource hardware specifications (ResourceSpecifications), and storage (Storage).
395415

396-
The MCP server provides two tiers:
397-
- **@access-mcp/xdmod** (TypeScript) — Public aggregate data via `public_user=true`. No auth required. Discovery tools + chart tools.
398-
- **@access-mcp/xdmod-data** (Python) — Authenticated per-user data via XDMoD API tokens. Requires `XDMOD_API_TOKEN`.
416+
Two MCP servers provide access at different tiers:
417+
- **@access-mcp/xdmod** (TypeScript, 6 tools) — Public aggregate data via `public_user=true`. No auth required. Discovery, chart data, chart images, and portal links.
418+
- **@access-mcp/xdmod-data** (Python, 7 tools) — Authenticated access via XDMoD API tokens. Per-user data, complex filtering, analysis templates, and NSF funding integration. Requires `XDMOD_API_TOKEN`.
399419

400420
## Notes
401421

docs/field-dictionary.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Field-level documentation for all ACCESS data sources.
1515
- [COManage/ACCESS Identity](#comanage)
1616
- [Event Registrations](#event_registrations)
1717
- [Events and Training](#events)
18+
- [XDMoD Metrics](#xdmod)
1819

1920
<h2 id="access_support_drupal">ACCESS Support Drupal</h2>
2021

@@ -239,3 +240,20 @@ Field-level documentation for all ACCESS data sources.
239240
- **Belongs To** `affinity_groups`: Events can be associated with an affinity group
240241
- **Has Many** `tags`: Events are tagged for discovery
241242
- **Has Many** `event_registrations`: Registration records for this event
243+
244+
<h2 id="xdmod">XDMoD Metrics</h2>
245+
246+
*HPC metrics, usage analytics, and resource specifications from the ACCESS XDMoD instance*
247+
248+
**Example questions this data can answer:**
249+
250+
- How much CPU time was used across ACCESS last quarter?
251+
- Which resources have the highest GPU utilization?
252+
- How many jobs ran on Delta in January 2024?
253+
- What science gateways are most active?
254+
- How are allocations distributed across fields of science?
255+
- What is the total GPU capacity across ACCESS resources?
256+
- Show me wait times by resource for the past month
257+
- How many active users and PIs are there?
258+
259+
*No fields documented.*

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ The ACCESS ecosystem spans dozens of data sources across multiple teams and trac
1919

2020
## Data Sources
2121

22+
### Metrics
23+
24+
| Source | Description | Access | |
25+
|--------|-------------|--------|---|
26+
| [XDMoD Metrics](field-dictionary#xdmod) | HPC metrics, usage analytics, and resource specifications from the ACCESS XDMoD instance | Varies | [MCP](https://access-mcp.netlify.app/servers/xdmod) · [API](https://xdmod.access-ci.org/controllers/user_interface.php) |
27+
2228
### Operations
2329

2430
| Source | Description | Access | |

docs/inventory.dbml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// ACCESS Data Inventory
2-
// Generated: 2026-02-13 18:43
2+
// Generated: 2026-02-24 17:53
33
// Source: data-sources/*.md
44

55
// =============================================================================
@@ -97,6 +97,21 @@ Enum data_source {
9797
priority: High
9898
''']
9999

100+
xdmod [note: '''
101+
name: XDMoD Metrics
102+
description: HPC metrics, usage analytics, and resource specifications from the ACCESS XDMoD instance
103+
category: Metrics & Reporting
104+
track: Metrics
105+
responsible_team: Metrics
106+
access_level: Varies
107+
is_canonical: true
108+
canonical_source: null
109+
mcp_available: true
110+
mcp_package: @access-mcp/xdmod
111+
api_endpoint: https://xdmod.access-ci.org/controllers/user_interface.php
112+
priority: High
113+
''']
114+
100115
}
101116

102117
// =============================================================================

0 commit comments

Comments
 (0)