Skip to main content
Glama

Northflank MCP by usefulapi

Get service

northflank_get_service
Read-only

Get details and current status of a single service. GET /v1/projects/{projectId}/services/{serviceId}.

Input Schema

NameRequiredDescriptionDefault
teamIdNoTeam id for an organization-scoped token.
projectIdYesProject id.
serviceIdYesService id (from northflank_list_services).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / teamId
      Added value: +{
      +  "description": "Team id for an organization-scoped token.",
      +  "maxLength": 100,
      +  "minLength": 3,
      +  "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. First observed

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds only the raw endpoint (GET /v1/projects/{projectId}/services/{serviceId}) as extra context, and says nothing about response shape, whether status is live or cached, or error behavior for a bad serviceId in an org-scoped context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the purpose and then the endpoint. Nothing is wasted, though the endpoint restates path parameters the schema already defines and could have carried behavioral detail instead.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description bears some burden for describing what comes back; "details and current status" is vague and the agent cannot tell which fields are returned or how status is represented. For a simple read-only getter it is minimally viable but not self-sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and all three parameters (including the optional teamId for organization-scoped tokens) are documented in the schema, so the baseline of 3 applies. The description adds no parameter meaning beyond what the schema already provides, and the useful hint about serviceId provenance lives in the schema, not the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Get details and current status of a single service" names a specific verb and resource and the word "single" implicitly contrasts it with the list siblings (northflank_list_services) and the metrics sibling. It stops short of naming those alternatives explicitly, so it is clear but not fully differentiated in-text.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can infer this is the tool for one known serviceId versus northflank_list_services for enumeration, but the description never states when to use it, when not to, or what to do if only a project name is known. No prerequisites or alternatives are offered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.