- 8 minutes to read

Nodinite Core MCP Server Tool Reference

Use this page when you need a fast, accurate map of every tool exposed by Nodinite.Core.McpServer.

  • Covers all 71 read-only tools across 18 feature areas
  • Shows required OAuth scope by area
  • Explains when to use list_*, search_*, get_*, and explain_* patterns
  • Shows the exact input names each tool family uses

Understanding the Tool Model

The MCP server is closed-world and read-only. It is designed for discovery, analysis, and architecture understanding in Nodinite.

graph TD A[" MCP Client"] --> B[" Nodinite.Core.McpServer"] B --> C[" Health"] B --> D[" Sources and Integrations"] B --> E[" Monitor Views and Log Views"] B --> F[" Repository Entities"]

Diagram: A single MCP client connects to Nodinite.Core.McpServer and queries health, integration monitoring, and repository data through read-only tool calls.

Core Facts

  • Tool count: 71
  • Naming: snake_case
  • Access model: Read-only, no write or destructive operations
  • No-match behavior for Get tools: Returns a short text message such as No X found with name 'Y'.

Authorization at a Glance

Scopes are enforced when OAuth mode is enabled. If OAuth is not configured (for example stdio or Windows authentication), authenticated callers can use all tools.

OAuth scope Feature areas
Public (no scope required) Health
mcp:monitoragents.read Sources
mcp:integrations.read Integrations
mcp:monitorviews.read Monitor Views
mcp:logviews.read Log Views
mcp:repository.read Systems, Services, EndPoints, Message Types, Contracts, Custom Fields, Custom Metadata, Articles, Domains, BPMs, Resources, Categories, Applications

Common Input and Paging Rules

Rule Behavior
take Clamped to 1-200, default 50
skip Clamped to 0+, default 0
name, term, title Empty or whitespace is rejected with an error
get_* no match Returns a short text message, not an exception

Tool Catalog by Feature Area

Start here if you are not sure which tool to call. Pick the feature area first, then read the tool name, then check the inputs column. If a tool name starts with list_, it usually shows many items. If it starts with search_, it looks for part of a name. If it starts with get_, it wants one exact item. A few tools use special filter inputs, and those are called out below.

Applications (4)

Use this family when you want to browse applications or jump straight to one application and its attached resources.

Tool Plain-English use Inputs
get_application_by_name Open one application by its exact name name
get_application_with_resources Open one application together with its monitored resources name
list_applications Show many applications at once take, skip
search_applications Find applications by part of a name term, take, skip

Articles (5)

Use this family when you want to browse help articles, find one by title, or list articles for a tag.

Tool Plain-English use Inputs
get_article_by_title Open one article by its exact title title
list_article_tags Show article tags take, skip
list_articles Show many articles at once take, skip
list_articles_by_tag Show articles that use one exact tag tagName
search_articles Find articles by part of a title term, take, skip

BPMs (3)

Use this family when you want business process models.

Tool Plain-English use Inputs
get_bpm_by_name Open one BPM by its exact name name
list_bpms Show many BPMs at once take, skip
search_bpms Find BPMs by part of a name term, take, skip

Categories (3)

Use this family when you want to browse or open categories used for resource grouping.

Tool Plain-English use Inputs
get_category_by_name Open one category by its exact name name
list_categories Show many categories at once take, skip
search_categories Find categories by part of a name term, take, skip

Contracts (5)

Use this family when you need contracts for a service or a system, or a contract by name.

Tool Plain-English use Inputs
get_contract_by_name Open one contract by its exact name name
list_contracts Show many contracts at once take, skip
list_contracts_by_service Show contracts that belong to one service serviceName
list_contracts_by_system Show contracts that belong to one system systemName
search_contracts Find contracts by part of a name term, take, skip

Custom Fields (3)

Use this family when you want custom field definitions.

Tool Plain-English use Inputs
get_custom_field_by_name Open one custom field by its exact name name
list_custom_fields Show many custom fields at once take, skip
search_custom_fields Find custom fields by part of a name term, take, skip

Custom Metadata (3)

Use this family when you want custom metadata definitions.

Tool Plain-English use Inputs
get_custom_metadata_by_name Open one custom metadata definition by its exact name name
list_custom_metadata Show many custom metadata definitions at once take, skip
search_custom_metadata Find custom metadata definitions by part of a name term, take, skip

Domains (3)

Use this family when you want business domains.

Tool Plain-English use Inputs
get_domain_by_name Open one domain by its exact name name
list_domains Show many domains at once take, skip
search_domains Find domains by part of a name term, take, skip

EndPoints (4)

Use this family when you want endpoints attached to a service or want one endpoint by name.

Tool Plain-English use Inputs
get_end_point_by_name Open one endpoint by its exact name name
list_end_points Show many endpoints at once take, skip
list_end_points_by_service Show endpoints that belong to one service serviceName
search_end_points Find endpoints by part of a name term, take, skip

Health (1)

Use this single tool when you just want to know whether the MCP server is healthy.

Tool Plain-English use Inputs
health Check server health, component checks, uptime, and version None

Integrations (6)

Use this family when you want to browse integrations, look up one exact integration, or filter by metadata.

Tool Plain-English use Inputs
explain_integration Open one integration with full architecture context name
get_integration_by_name Open one integration by its exact name name
get_integration_with_relationships Open one integration together with its related services, systems, and contracts name
list_integrations Show many integrations at once take, skip
list_integrations_with_metadata Show integrations that match a metadata name or value metadataValueSubstring, take, skip
search_integrations Find integrations by part of a name term, take, skip

Log Views (4)

Use this family when you want log views and the log scope they define.

Tool Plain-English use Inputs
explain_log_view Open one log view with the full scoped activity context name
get_log_view_by_name Open one log view by its exact name name
list_log_views Show many log views at once take, skip
search_log_views Find log views by part of a name term, take, skip

Message Types (3)

Use this family when you want message type definitions.

Tool Plain-English use Inputs
get_message_type_by_name Open one message type by its exact name name
list_message_types Show many message types at once take, skip
search_message_types Find message types by part of a name term, take, skip

Monitor Views (5)

Use this family when you want monitor views and the integrations they track.

Tool Plain-English use Inputs
explain_monitor_view Open one monitor view with health details and full scope name
get_monitor_view_by_name Open one monitor view by its exact name name
list_monitor_views Show many monitor views at once take, skip
list_monitor_views_with_integration_metadata Show monitor views that match integration metadata metadataValueSubstring, take, skip
search_monitor_views Find monitor views by part of a name term, take, skip

Resources (5)

Use this family when you want monitored resources or resources grouped by category or application.

Tool Plain-English use Inputs
get_resource_by_name Open one monitored resource by its exact name name
list_resources Show many monitored resources at once take, skip
list_resources_by_application Show resources that belong to one application applicationName
list_resources_by_category Show resources in one category categoryName
search_resources Find resources by part of a name term, take, skip

Services (6)

Use this family when you want services, the systems they belong to, or the endpoints and contracts attached to them.

Tool Plain-English use Inputs
explain_service Open one service with endpoints and contracts in one view name
get_service_by_name Open one service by its exact name name
list_services Show many services at once take, skip
list_services_by_integration Show services that participate in one integration integrationName
list_services_by_system Show services that belong to one system systemName
search_services Find services by part of a name term, take, skip

Sources / Monitor Agents (3)

Use this family when you want monitor agents, which the MCP server calls sources.

Tool Plain-English use Inputs
get_source_by_name Open one source by its exact name name
list_sources Show many sources at once take, skip
search_sources Find sources by part of a name term, take, skip

Systems (5)

Use this family when you want systems and the services inside them.

Tool Plain-English use Inputs
explain_system Open one system with services, contracts, and relations in one view name
get_system_by_name Open one system by its exact name name
get_system_with_services Open one system together with its child services name
list_systems Show many systems at once take, skip
search_systems Find systems by part of a name term, take, skip

Choosing the Right Tool Pattern

Use this summary when you already know the kind of answer you want. The catalog above gives the exact inputs for each tool family.

Pattern Use when Common inputs Typical examples
list_* You need broad browsing take, skip list_integrations, list_resources
search_* You know part of a name term, take, skip search_services, search_log_views
get_*_by_name or get_*_by_title You know the exact identifier name or title get_integration_by_name, get_article_by_title
get_*_with_* You need one entity plus direct relations usually name get_system_with_services, get_application_with_resources
explain_* You need comprehensive architecture context usually name explain_service, explain_monitor_view

Next Step