Rank
83
A Model Context Protocol (MCP) server for GitLab
Traction
No public download signal
Freshness
Updated 2d ago
Crawler Summary
TypeScript SDK for the 1EdTech OneRoster API oneroster Developer-friendly & type-safe Typescript SDK specifically catered to leverage *oneroster* API. <div align="left"> <a href="https://www.speakeasy.com/?utm_source=oneroster&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <i Published capability contract available. No trust telemetry is available yet. 9 GitHub stars reported by the source. Last updated 2/24/2026.
Freshness
Last checked 2/22/2026
Best For
Contract is available with explicit auth and schema references.
Not Ideal For
@superbuilders/oneroster is not ideal for teams that need stronger public trust telemetry, lower setup complexity, or more explicit contract coverage before production rollout.
Evidence Sources Checked
editorial-content, capability-contract, runtime-metrics, public facts pack
TypeScript SDK for the 1EdTech OneRoster API oneroster Developer-friendly & type-safe Typescript SDK specifically catered to leverage *oneroster* API. <div align="left"> <a href="https://www.speakeasy.com/?utm_source=oneroster&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <i
Public facts
7
Change events
1
Artifacts
0
Freshness
Feb 22, 2026
Published capability contract available. No trust telemetry is available yet. 9 GitHub stars reported by the source. Last updated 2/24/2026.
Trust score
Unknown
Compatibility
MCP
Freshness
Feb 22, 2026
Vendor
Trilogy Group
Artifacts
0
Benchmarks
0
Last release
0.7.0
Key links, install path, and a quick operational read before the deeper crawl record.
Summary
Published capability contract available. No trust telemetry is available yet. 9 GitHub stars reported by the source. Last updated 2/24/2026.
Setup snapshot
git clone https://github.com/trilogy-group/oneroster-ts.gitSetup complexity is MEDIUM. Standard integration tests and API key provisioning are required before connecting this to production workloads.
Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data.
Everything public we have scraped or crawled about this agent, grouped by evidence type with provenance.
Vendor
Trilogy Group
Protocol compatibility
MCP
Auth modes
mcp, api_key, oauth
Machine-readable schemas
OpenAPI or schema references published
Adoption signal
9 GitHub stars
Handshake status
UNKNOWN
Crawlable docs
6 indexed pages on the official domain
Merged public release, docs, artifact, benchmark, pricing, and trust refresh events.
Extracted files, examples, snippets, parameters, dependencies, permissions, and artifact metadata.
Extracted files
0
Examples
6
Snippets
0
Languages
typescript
text
curl -X POST https://alpha-auth-production-idp.auth.us-west-2.amazoncognito.com/oauth2/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials&client_id=<your-client-id>&client_secret=<your-client-secret>"
text
GET /ims/oneroster/rostering/v1p2/users?offset=20&limit=20
text
?filter=[field][operator][value]
text
GET /ims/oneroster/rostering/v1p2/users?filter=status='active'
text
GET /ims/oneroster/rostering/v1p2/users?filter=status='active' AND name='John'
text
GET /ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc
Full documentation captured from public sources, including the complete README when available.
Docs source
GITHUB MCP
Editorial quality
ready
TypeScript SDK for the 1EdTech OneRoster API oneroster Developer-friendly & type-safe Typescript SDK specifically catered to leverage *oneroster* API. <div align="left"> <a href="https://www.speakeasy.com/?utm_source=oneroster&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <i
Developer-friendly & type-safe Typescript SDK specifically catered to leverage oneroster API.
<div align="left"> <a href="https://www.speakeasy.com/?utm_source=oneroster&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" /> </a> </div> <!-- Start Summary [summary] -->OneRoster API: # Authentication
All endpoints require authentication using the Authorization: Bearer <token> header.
The token can be obtained with:
curl -X POST https://alpha-auth-production-idp.auth.us-west-2.amazoncognito.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=<your-client-id>&client_secret=<your-client-secret>"
Use the correct IDP server depending on the environment you're using:
Production Server:
https://alpha-auth-production-idp.auth.us-west-2.amazoncognito.com
Staging Server:
https://alpha-auth-development-idp.auth.us-west-2.amazoncognito.com
Reach out to the platform team to get a client/secret pair for your application.
Our API uses offset pagination for list endpoints. Paginated responses include the following fields:
offset: Offset for the next page of resultslimit: Number of items per page (default: 100)Example request:
GET /ims/oneroster/rostering/v1p2/users?offset=20&limit=20
All listing endpoints support offset pagination.
All listing endpoints support filtering using the filter query parameter, following 1EdTech's filtering specification.
The filter should be a string with the following format:
?filter=[field][operator][value]
Example request:
GET /ims/oneroster/rostering/v1p2/users?filter=status='active'
Example request with multiple filters:
GET /ims/oneroster/rostering/v1p2/users?filter=status='active' AND name='John'
Filtering by nested relations is not supported.
All listing endpoints support sorting using the sort and orderBy query parameters, following 1EdTech's sorting specification
Example request:
GET /ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @superbuilders/oneroster
pnpm add @superbuilders/oneroster
bun add @superbuilders/oneroster
yarn add @superbuilders/oneroster zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
<details> <summary>Claude installation steps</summary>Node.js v20 or greater is required to run the MCP server from npm.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"OneRoster": {
"command": "npx",
"args": [
"-y", "--package", "@superbuilders/oneroster",
"--",
"mcp", "start",
"--client-id", "...",
"--client-secret", "...",
"--token-url", "..."
]
}
}
}
</details>
<details>
<summary>Cursor installation steps</summary>
Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"OneRoster": {
"command": "npx",
"args": [
"-y", "--package", "@superbuilders/oneroster",
"--",
"mcp", "start",
"--client-id", "...",
"--client-secret", "...",
"--token-url", "..."
]
}
}
}
</details>
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
For a full list of server arguments, run:
npx -y --package @superbuilders/oneroster -- mcp start --help
<!-- End SDK Installation [installation] -->
<!-- Start Requirements [requirements] -->
For supported JavaScript runtimes, please consult RUNTIMES.md.
<!-- End Requirements [requirements] --> <!-- Start SDK Example Usage [usage] -->import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
}
run();
<!-- End SDK Example Usage [usage] -->
<!-- Start Authentication [security] -->
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| ----------------------------- | ------ | ------------------------------ | ----------------------------------------------------------------------------- |
| clientID<br/>clientSecret | oauth2 | OAuth2 Client Credentials Flow | ONEROSTER_CLIENT_ID<br/>ONEROSTER_CLIENT_SECRET<br/>ONEROSTER_TOKEN_URL |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:
import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
}
run();
<!-- End Authentication [security] -->
<!-- Start Available Resources and Operations [operations] -->
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
<details> <summary>Available standalone functions</summary>academicSessionsManagementDeleteAcademicSession - Delete an Academic SessionacademicSessionsManagementGetAcademicSession - Get a specific Academic SessionacademicSessionsManagementGetAllAcademicSessions - Get all Academic SessionsacademicSessionsManagementPostAcademicSession - Create an Academic SessionacademicSessionsManagementPutAcademicSession - Update an Academic SessionassessmentLineItemsManagementCreateAssessmentLineItem - Create an Assessment Line ItemassessmentLineItemsManagementDeleteAssessmentLineItem - Delete an Assessment Line ItemassessmentLineItemsManagementGetAllAssessmentLineItems - Get all Assessment Line ItemsassessmentLineItemsManagementGetAssessmentLineItem - Get an Assessment Line ItemassessmentLineItemsManagementUpdateAssessmentLineItem - Update an Assessment Line ItemassessmentResultsManagementCreateAssessmentResult - Create an Assessment ResultassessmentResultsManagementDeleteAssessmentResult - Delete an Assessment ResultassessmentResultsManagementGetAllAssessmentResults - Get all Assessment ResultsassessmentResultsManagementGetAssessmentResult - Get an Assessment ResultassessmentResultsManagementUpdateAssessmentResult - Update an Assessment ResultcategoriesManagementCreateCategory - Create a CategorycategoriesManagementDeleteCategory - Delete a CategorycategoriesManagementGetAllCategories - Get all CategoriescategoriesManagementGetCategory - Get a CategorycategoriesManagementUpdateCategory - Update a CategoryclassesManagementAddStudentToClass - Add a student to a ClassclassesManagementAddStudentToClass - Add a student to a ClassclassesManagementAddTeacherToClass - Add a teacher to a ClassclassesManagementAddTeacherToClass - Add a teacher to a ClassclassesManagementCreateClass - Create a new ClassclassesManagementDeleteClass - Delete a ClassclassesManagementGetAllClasses - Get all ClassesclassesManagementGetCategoriesForClass - Get Categories for a ClassclassesManagementGetClass - Get a specific classclassesManagementGetClassesForStudent - Get Classes for a StudentclassesManagementGetClassesForStudent - Get Classes for a StudentclassesManagementGetClassesForTeacher - Get Classes for a TeacherclassesManagementGetClassesForTeacher - Get Classes for a TeacherclassesManagementGetClassesForTerm - Get Classes for a TermclassesManagementGetClassesForTerm - Get Classes for a TermclassesManagementGetClassesForUser - Get Classes for a UserclassesManagementGetClassesForUser - Get Classes for a UserclassesManagementGetLineItemsForClass - Get Line Items for a ClassclassesManagementGetResultsForClass - Get Results for a ClassclassesManagementGetResultsForLineItemForClass - Get Results for a Line Item for a ClassclassesManagementGetResultsForStudentForClass - Get Results for a Student for a ClassclassesManagementGetScoreScalesForClass - Get Score Scales for a ClassclassesManagementGetStudentsForClass - Get students for a ClassclassesManagementGetStudentsForClass - Get students for a ClassclassesManagementGetTeachersForClass - Get teachers for a ClassclassesManagementGetTeachersForClass - Get teachers for a ClassclassesManagementPostResultsForAcademicSessionForClass - Create Results for an Academic Session for a ClassclassesManagementUpdateClass - Update a ClasscoursesManagementCreateComponentResource - Create Component ResourcecoursesManagementCreateComponentResource - Create Component ResourcecoursesManagementCreateCourse - Create a CoursecoursesManagementCreateCourseComponent - Create Course ComponentcoursesManagementCreateCourseComponent - Create Course ComponentcoursesManagementDeleteComponentResource - Delete a Component ResourcecoursesManagementDeleteComponentResource - Delete a Component ResourcecoursesManagementDeleteCourse - Delete a CoursecoursesManagementDeleteCourseComponent - Delete a Course ComponentcoursesManagementDeleteCourseComponent - Delete a Course ComponentcoursesManagementGetAllComponentResources - Get all Component ResourcescoursesManagementGetAllComponentResources - Get all Component ResourcescoursesManagementGetAllCourseComponents - Get all Course ComponentscoursesManagementGetAllCourseComponents - Get all Course ComponentscoursesManagementGetAllCourses - Get All CoursescoursesManagementGetClassesForCourse - Get Classes for a CoursecoursesManagementGetComponentResource - Get a specific Component ResourcecoursesManagementGetComponentResource - Get a specific Component ResourcecoursesManagementGetCourse - Get a specific CoursecoursesManagementGetCourseComponent - Get a specific Course ComponentcoursesManagementGetCourseComponent - Get a specific Course ComponentcoursesManagementPutComponentResource - Update a Component ResourcecoursesManagementPutComponentResource - Update a Component ResourcecoursesManagementPutCourse - Update a CoursecoursesManagementPutCourseComponent - Update a Course ComponentcoursesManagementPutCourseComponent - Update a Course ComponentdemographicsManagementDeleteDemographics - Delete a Demographic recorddemographicsManagementGetAllDemographics - Get all Demographic recordsdemographicsManagementGetDemographics - Get a specific Demographic recorddemographicsManagementPostDemographics - Create a new Demographic recorddemographicsManagementPutDemographics - Update a Demographic recordenrollmentsManagementCreateEnrollment - Create a new EnrollmentenrollmentsManagementDeleteEnrollment - Delete an EnrollmentenrollmentsManagementGetAllEnrollments - Get all EnrollmentsenrollmentsManagementGetEnrollment - Get a specific EnrollmentenrollmentsManagementUpdateEnrollment - Update an EnrollmentgradingPeriodsManagementCreateGradingPeriod - Create a new Grading PeriodgradingPeriodsManagementDeleteGradingPeriod - Delete a Grading PeriodgradingPeriodsManagementGetAllGradingPeriods - Get all Grading PeriodsgradingPeriodsManagementGetGradingPeriod - Get a specific Grading PeriodgradingPeriodsManagementUpdateGradingPeriod - Update a Grading PeriodlineItemsManagementCreateLineItem - Create a Line ItemlineItemsManagementCreateResultForLineItem - Create a Result for a Line ItemlineItemsManagementDeleteLineItem - Delete a Line ItemlineItemsManagementGetAllLineItems - Get all Line ItemslineItemsManagementGetLineItem - Get a Line ItemlineItemsManagementUpdateLineItem - Update a Line ItemorganizationsManagementCreateOrg - Create an OrganizationorganizationsManagementDeleteOrg - Delete an OrganizationorganizationsManagementGetAllOrgs - Get all OrganizationsorganizationsManagementGetOrg - Get a specific OrganizationorganizationsManagementUpdateOrg - Update an OrganizationresourcesManagementCreateResource - Create a new ResourceresourcesManagementDeleteResource - Delete a resourceresourcesManagementExportResourceToCommonCartridge - Export Resource to Common CartridgeresourcesManagementGetAllResources - Get all ResourcesresourcesManagementGetResource - Get a specific ResourceresourcesManagementGetResourcesForClass - Get resources for a classresourcesManagementGetResourcesForCourse - Get resources for a courseresourcesManagementGetResourcesForUser - Get resources for a userresourcesManagementUpdateResource - Update an existing ResourceresultsManagementCreateResult - Create a ResultresultsManagementDeleteResult - Delete a ResultresultsManagementGetAllResults - Get all ResultsresultsManagementGetResult - Get a ResultresultsManagementUpdateResult - Update a ResultschoolsManagementCreateLineItemsForSchool - Create Line Items for a SchoolschoolsManagementCreateLineItemsForSchool - Create Line Items for a SchoolschoolsManagementCreateSchool - Create a new SchoolschoolsManagementDeleteSchool - Delete a SchoolschoolsManagementGetAllSchools - Get all SchoolsschoolsManagementGetClassesForSchool - Get all Classes for a SchoolschoolsManagementGetClassesForSchool - Get all Classes for a SchoolschoolsManagementGetCoursesForSchool - Get all Courses for a SchoolschoolsManagementGetCoursesForSchool - Get all Courses for a SchoolschoolsManagementGetEnrollmentsForClassInSchool - Get Enrollments for a specific Class in a SchoolschoolsManagementGetEnrollmentsForClassInSchool - Get Enrollments for a specific Class in a SchoolschoolsManagementGetEnrollmentsForSchool - Get all Enrollments for a SchoolschoolsManagementGetEnrollmentsForSchool - Get all Enrollments for a SchoolschoolsManagementGetLineItemsForSchool - Get Line Items for a SchoolschoolsManagementGetLineItemsForSchool - Get Line Items for a SchoolschoolsManagementGetSchool - Get a specific SchoolschoolsManagementGetStudentsForClassInSchool - Get Students for a specific Class in a SchoolschoolsManagementGetStudentsForClassInSchool - Get Students for a specific Class in a SchoolschoolsManagementGetStudentsForSchool - Get all Students for a SchoolschoolsManagementGetStudentsForSchool - Get all Students for a SchoolschoolsManagementGetTeachersForClassInSchool - Get Teachers for a specific Class in a SchoolschoolsManagementGetTeachersForClassInSchool - Get Teachers for a specific Class in a SchoolschoolsManagementGetTeachersForSchool - Get all teachers for a schoolschoolsManagementGetTeachersForSchool - Get all teachers for a schoolschoolsManagementGetTermsForSchool - Get all Terms for a SchoolschoolsManagementGetTermsForSchool - Get all Terms for a SchoolschoolsManagementUpdateSchool - Update a SchoolscoreScalesManagementCreateScoreScale - Create a Score ScalescoreScalesManagementDeleteScoreScale - Delete a Score ScalescoreScalesManagementGetAllScoreScales - Get all Score ScalesscoreScalesManagementGetScoreScale - Get a Score ScalescoreScalesManagementGetScoreScalesForSchool - Get Score Scales for a SchoolscoreScalesManagementGetScoreScalesForSchool - Get Score Scales for a SchoolscoreScalesManagementUpdateScoreScale - Update a Score ScalestudentsManagementGetAllStudents - Get all StudentsstudentsManagementGetStudent - Get a specific StudentteachersManagementGetAllTeachers - Get all TeachersteachersManagementGetTeacher - Get a specific TeachertermsManagementCreateGradingPeriodForTerm - Create a new Grading Period for a TermtermsManagementCreateGradingPeriodForTerm - Create a new Grading Period for a TermtermsManagementGetAllTerms - Get all TermstermsManagementGetGradingPeriodsForTerm - Get Grading Periods for a TermtermsManagementGetGradingPeriodsForTerm - Get Grading Periods for a TermtermsManagementGetTerm - Get a specific TermusersManagementCreateUser - Create a new UserusersManagementDeleteUser - Delete a UserusersManagementGetAllUsers - Get all UsersusersManagementGetUser - Get a specific UserusersManagementGetUserWithDemographics - Get a specific User with demographicsusersManagementUpdateUser - Update an existing UserSome of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
}
run();
<!-- End Pagination [pagination] -->
<!-- Start Retries [retries] -->
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
for await (const page of result) {
console.log(page);
}
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
}
run();
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
OneRosterError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
import { OneRoster } from "@superbuilders/oneroster";
import * as errors from "@superbuilders/oneroster/models/errors";
const oneRoster = new OneRoster({
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
try {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.OneRosterError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.BadRequestResponseError) {
console.log(error.data$.imsxCodeMajor); // string
console.log(error.data$.imsxSeverity); // string
console.log(error.data$.imsxDescription); // string
console.log(error.data$.imsxCodeMinor); // errors.BadRequestResponseImsxCodeMinor
console.log(error.data$.imsxErrorDetails); // { [k: string]: string }[]
}
}
}
}
run();
Primary errors:
OneRosterError: The base class for HTTP error responses.
NotFoundResponseError: *UnprocessableEntityResponseError: Status code 422. *TooManyRequestsResponseError: Too Many Requests. Status code 429. *InternalServerErrorResponse: Status code 500. *Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.Inherit from OneRosterError:
BadRequestResponseError: Status code 400. Applicable to 131 of 164 methods.*UnauthorizedRequestResponseError: Status code 401. Applicable to 131 of 164 methods.*ForbiddenResponseError: Status code 403. Applicable to 131 of 164 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.* Check the method documentation to see if the error is applicable.
<!-- End Error Handling [errors] --> <!-- Start Server Selection [server] -->The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { OneRoster } from "@superbuilders/oneroster";
const oneRoster = new OneRoster({
serverURL: "https://api.alpha-1edtech.com",
security: {
clientID: process.env["ONEROSTER_CLIENT_ID"] ?? "",
clientSecret: process.env["ONEROSTER_CLIENT_SECRET"] ?? "",
},
});
async function run() {
const result = await oneRoster.scoreScalesManagement.getAllScoreScales({
fields: "sourcedId,name",
filter: "status='active'",
});
for await (const page of result) {
console.log(page);
}
}
run();
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { OneRoster } from "@superbuilders/oneroster";
import { HTTPClient } from "@superbuilders/oneroster/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new OneRoster({ httpClient });
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Debugging [debug] -->
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { OneRoster } from "@superbuilders/oneroster";
const sdk = new OneRoster({ debugLogger: console });
You can also enable a default debug logger by setting an environment variable ONEROSTER_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
Machine endpoints, protocol fit, contract coverage, invocation examples, and guardrails for agent-to-agent use.
Contract coverage
Status
ready
Auth
mcp, api_key, oauth
Streaming
No
Data region
global
Protocol support
Requires: mcp, lang:typescript
Forbidden: none
Guardrails
Operational confidence: medium
curl -s "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/snapshot"
curl -s "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract"
curl -s "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/trust"
Trust and runtime signals, benchmark suites, failure patterns, and practical risk constraints.
Trust signals
Handshake
UNKNOWN
Confidence
unknown
Attempts 30d
unknown
Fallback rate
unknown
Runtime metrics
Observed P50
unknown
Observed P95
unknown
Rate limit
unknown
Estimated cost
unknown
Every public screenshot, visual asset, demo link, and owner-provided destination tied to this agent.
Neighboring agents from the same protocol and source ecosystem for comparison and shortlist building.
Rank
83
A Model Context Protocol (MCP) server for GitLab
Traction
No public download signal
Freshness
Updated 2d ago
Rank
80
A Model Context Protocol (MCP) server for GitLab
Traction
No public download signal
Freshness
Updated 2d ago
Rank
74
Expose OpenAPI definition endpoints as MCP tools using the official Rust SDK for the Model Context Protocol (https://github.com/modelcontextprotocol/rust-sdk)
Traction
No public download signal
Freshness
Updated 2d ago
Rank
72
An actix_web backend for the official Rust SDK for the Model Context Protocol (https://github.com/modelcontextprotocol/rust-sdk)
Traction
No public download signal
Freshness
Updated 2d ago
Contract JSON
{
"contractStatus": "ready",
"authModes": [
"mcp",
"api_key",
"oauth"
],
"requires": [
"mcp",
"lang:typescript"
],
"forbidden": [],
"supportsMcp": true,
"supportsA2a": false,
"supportsStreaming": false,
"inputSchemaRef": "https://github.com/trilogy-group/oneroster-ts#input",
"outputSchemaRef": "https://github.com/trilogy-group/oneroster-ts#output",
"dataRegion": "global",
"contractUpdatedAt": "2026-02-24T19:45:16.820Z",
"sourceUpdatedAt": "2026-02-24T19:45:16.820Z",
"freshnessSeconds": 4440455
}Invocation Guide
{
"preferredApi": {
"snapshotUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/snapshot",
"contractUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"trustUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/trust"
},
"curlExamples": [
"curl -s \"https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/snapshot\"",
"curl -s \"https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract\"",
"curl -s \"https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/trust\""
],
"jsonRequestTemplate": {
"query": "summarize this repo",
"constraints": {
"maxLatencyMs": 2000,
"protocolPreference": [
"MCP"
]
}
},
"jsonResponseTemplate": {
"ok": true,
"result": {
"summary": "...",
"confidence": 0.9
},
"meta": {
"source": "GITHUB_MCP",
"generatedAt": "2026-04-17T05:12:52.672Z"
}
},
"retryPolicy": {
"maxAttempts": 3,
"backoffMs": [
500,
1500,
3500
],
"retryableConditions": [
"HTTP_429",
"HTTP_503",
"NETWORK_TIMEOUT"
]
}
}Trust JSON
{
"status": "unavailable",
"handshakeStatus": "UNKNOWN",
"verificationFreshnessHours": null,
"reputationScore": null,
"p95LatencyMs": null,
"successRate30d": null,
"fallbackRate": null,
"attempts30d": null,
"trustUpdatedAt": null,
"trustConfidence": "unknown",
"sourceUpdatedAt": null,
"freshnessSeconds": null
}Capability Matrix
{
"rows": [
{
"key": "MCP",
"type": "protocol",
"support": "supported",
"confidenceSource": "contract",
"notes": "Confirmed by capability contract"
},
{
"key": "cli",
"type": "capability",
"support": "supported",
"confidenceSource": "profile",
"notes": "Declared in agent profile metadata"
}
],
"flattenedTokens": "protocol:MCP|supported|contract capability:cli|supported|profile"
}Facts JSON
[
{
"factKey": "docs_crawl",
"category": "integration",
"label": "Crawlable docs",
"value": "6 indexed pages on the official domain",
"href": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
"sourceUrl": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
"sourceType": "search_document",
"confidence": "medium",
"observedAt": "2026-04-15T05:03:46.393Z",
"isPublic": true
},
{
"factKey": "protocols",
"category": "compatibility",
"label": "Protocol compatibility",
"value": "MCP",
"href": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"sourceUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"sourceType": "contract",
"confidence": "high",
"observedAt": "2026-02-24T19:45:16.820Z",
"isPublic": true
},
{
"factKey": "auth_modes",
"category": "compatibility",
"label": "Auth modes",
"value": "mcp, api_key, oauth",
"href": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"sourceUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"sourceType": "contract",
"confidence": "high",
"observedAt": "2026-02-24T19:45:16.820Z",
"isPublic": true
},
{
"factKey": "schema_refs",
"category": "artifact",
"label": "Machine-readable schemas",
"value": "OpenAPI or schema references published",
"href": "https://github.com/trilogy-group/oneroster-ts#input",
"sourceUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/contract",
"sourceType": "contract",
"confidence": "high",
"observedAt": "2026-02-24T19:45:16.820Z",
"isPublic": true
},
{
"factKey": "vendor",
"category": "vendor",
"label": "Vendor",
"value": "Trilogy Group",
"href": "https://github.com/trilogy-group/oneroster-ts",
"sourceUrl": "https://github.com/trilogy-group/oneroster-ts",
"sourceType": "profile",
"confidence": "medium",
"observedAt": "2026-02-24T19:43:14.176Z",
"isPublic": true
},
{
"factKey": "traction",
"category": "adoption",
"label": "Adoption signal",
"value": "9 GitHub stars",
"href": "https://github.com/trilogy-group/oneroster-ts",
"sourceUrl": "https://github.com/trilogy-group/oneroster-ts",
"sourceType": "profile",
"confidence": "medium",
"observedAt": "2026-02-24T19:43:14.176Z",
"isPublic": true
},
{
"factKey": "handshake_status",
"category": "security",
"label": "Handshake status",
"value": "UNKNOWN",
"href": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/trust",
"sourceUrl": "https://xpersona.co/api/v1/agents/mcp-trilogy-group-oneroster-ts/trust",
"sourceType": "trust",
"confidence": "medium",
"observedAt": null,
"isPublic": true
}
]Change Events JSON
[
{
"eventType": "docs_update",
"title": "Docs refreshed: Sign in to GitHub · GitHub",
"description": "Fresh crawlable documentation was indexed for the official domain.",
"href": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
"sourceUrl": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
"sourceType": "search_document",
"confidence": "medium",
"observedAt": "2026-04-15T05:03:46.393Z",
"isPublic": true
}
]Sponsored
Ads related to @superbuilders/oneroster and adjacent AI workflows.