Skip to main content
Glama
ahmedselimmansor-ctrl

IBM Cloud MCP Server

iam_get_service_id

Retrieve details of a specific service ID in IBM Cloud IAM. Provide the UUID to get its configuration and metadata.

Instructions

Get details of a specific service ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
service_idYesThe ID of the service ID (UUID)

Implementation Reference

  • The handler function that executes the 'iam_get_service_id' tool logic. It takes a 'service_id' parameter and makes a GET request to the IAM Identity API endpoint '/v1/serviceids/{service_id}' to retrieve details of a specific service ID.
      async ({ service_id }) => safeTool(async () => {
        return client.get(`${iamIdentityBase}/serviceids/${service_id}`);
      })
    );
  • Input schema for the 'iam_get_service_id' tool. Defines a single required parameter 'service_id' (string UUID) for identifying the service ID to retrieve.
    {
      service_id: z.string().describe("The ID of the service ID (UUID)"),
    },
  • Registration of the 'iam_get_service_id' tool via server.tool(), with its name, description, schema, and handler function. Part of the registerIAMTools() function called from server.ts.
    server.tool(
      "iam_get_service_id",
      "Get details of a specific service ID",
      {
        service_id: z.string().describe("The ID of the service ID (UUID)"),
      },
      async ({ service_id }) => safeTool(async () => {
        return client.get(`${iamIdentityBase}/serviceids/${service_id}`);
      })
    );
  • The safeTool helper wraps the handler logic to catch errors and return proper MCP response format (success or error content).
    export async function safeTool<T>(fn: () => Promise<T>): Promise<ReturnType<typeof successContent> | ReturnType<typeof errorContent>> {
      try {
        const result = await fn();
        return successContent(result);
      } catch (error) {
        return errorContent(error);
      }
    }
  • The IAM_IDENTITY endpoint constant used to build the API URL for the 'iam_get_service_id' tool (resolves to 'https://iam.cloud.ibm.com/v1/serviceids/{service_id}').
    IAM_IDENTITY: "https://iam.cloud.ibm.com/v1",
Behavior3/5

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

No annotations are provided, so the description must disclose behavioral traits. It states 'Get details,' implying a read-only operation. However, it does not mention authentication, error behavior, or rate limits. For a simple read, this is adequate but minimal.

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

Conciseness5/5

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

The description is a single, front-loaded sentence of 6 words with no wasted content. It is appropriately sized for the task.

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

Completeness2/5

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

Despite the tool's simplicity, the description fails to specify what 'details' are returned. Since there is no output schema, the agent is left guessing about the response content, making it incomplete.

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?

The input schema has 100% description coverage, with the parameter 'service_id' clearly described as a UUID. The description adds no additional meaning beyond the schema, so the baseline score of 3 applies.

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

Purpose5/5

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

The description 'Get details of a specific service ID' clearly specifies the action (get) and resource (service ID details), distinguishing it from sibling tools like iam_list_service_ids (list) and iam_delete_service_id (delete).

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?

The description does not provide explicit guidance on when to use this tool vs alternatives. Usage is implied based on the tool name and siblings, but no clear context or exclusions are given.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ahmedselimmansor-ctrl/IBM_cloud_MCP_SERVER'

If you have feedback or need assistance with the MCP directory API, please join our Discord server