Semogram Docs
MCPTools reference

ontology_term_records_read

Read one page of records for a class term of the compiled project ontology, with optional related terms in select. Read policies and masking apply.

When to use it

Use ontology_term_records_read to read records of an ontology term. On the workspace endpoint, pass projectId from project_list. On a project-scoped endpoint, the project is already bound: omit that argument and use the schema discovered from that endpoint.

Plugin requirements

Plugin requirements depend on the read route. Reads routed through a data endpoint use its installed connector or fact-store capability; they require a configured installation supporting that operation. This does not make every ontology read plugin-dependent. Use the plugin setup guides for configuration. Inspect the workspace’s plugin installations and check the installation before executing it.

Arguments

NameTypeRequiredDefaultConstraints
termstringYes—Minimum length: 1; Maximum length: 1000
packageIdstringNo—Format: uuid; Pattern constraint; see full schema
packageVersionintegerNo—Maximum: 9007199254740991; Greater than: 0
selectarrayNo[]Maximum items: 100; Items: string
limitintegerNo100Minimum: 1; Maximum: 500
offsetintegerNo0Minimum: 0; Maximum: 9007199254740991
projectIdstringYes—Format: uuid; Pattern constraint; see full schema

View the complete input schema, including nested contracts and alternative shapes. The schema is extracted from the workspace server’s Zod definitions. Runtime validation also enforces custom checks that JSON Schema cannot express.

Response shape

The operation-specific payload is returned in data; its contents follow the operation described above.

MCP returns a text block containing the JSON operation result and a structuredContent copy. The envelope includes data, completeness, truncated, freshness, and warnings. Depending on the operation it can also include nextCursor, evidence, job, or receipt.

Check those fields before treating a conversational summary as the result. When a job is returned, inspect its status with the appropriate execution tool; a queued response is not confirmation that work finished. Follow evidence links when checking the underlying records.

Input methods

This request illustrates the argument structure. Replace every angle-bracket placeholder with a real value and supply any applicable optional fields from the schema. Nested business contracts must match your actual configuration. Send it through an authenticated, initialized MCP client; this JSON alone does not establish a session or sign you in.

Use Semogram’s ontology_term_records_read tool to read records of an ontology term. Confirm the workspace and use records I can access. Do not change anything.

Choose the project explicitly before making this request. Use real resource IDs returned by earlier reads; a resource name is not a UUID. Do not fill missing business inputs with invented values.

This is an MCP tools/call request, not a form to paste into Semogram. Send it through an authenticated, initialized MCP client.

MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "ontology_term_records_read",
    "arguments": {
      "term": "<TERM>",
      "projectId": "<PROJECT_ID_UUID>"
    }
  }
}

FAQ

What access and approvals are required?

Required permission scopes: data:read. OAuth uses current workspace membership; API keys use their assigned scopes and grants. Discovery can exclude tools the caller cannot use.

Read-only annotation: Yes. Destructive annotation: No. Follow the operation’s declared contract and any applicable server-side approval policy.

How should I handle retries?

Do not assume repeated calls are safe merely because the client offers Retry. Inspect the result or existing request before repeating work that changes state. For 429 responses, honor Retry-After rather than retrying immediately.

Why is this tool missing or returning an error?

Confirm the workspace, resource IDs, and permission scopes. Read the returned error before changing the request. See connection, authentication and troubleshooting for sign-in, scope, resource access, and rate-limit errors.