Skip to main content
Glama
prismism-dev

Prismism MCP Server

by prismism-dev

Prismism Health Check

prismism_health

Check if the Prismism MCP server is operational and API keys are properly configured to enable file uploads and link generation from AI agents.

Instructions

Verify that the Prismism MCP server is running and the API key is configured correctly. Call this first to confirm your setup works before doing anything else.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Registration of the 'prismism_health' tool.
    server.registerTool(
      'prismism_health',
      {
        title: 'Prismism Health Check',
        description:
          'Verify that the Prismism MCP server is running and the API key is configured correctly. Call this first to confirm your setup works before doing anything else.',
      },
      async () => {
        const baseUrl = getBaseUrl();
        const hasKey = hasApiKey();
    
        if (!hasKey) {
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify({
                  ok: true,
                  data: {
                    baseUrl,
                    authenticated: false,
                    version: VERSION,
                  },
                  _hints: [
                    'No API key configured. Set PRISMISM_API_KEY in your MCP config to authenticate.',
                    'Register at https://prismism.dev or use the prismism_register tool to create an account.',
                  ],
                }),
              },
            ],
          };
        }
    
        // Verify the key works by hitting the account endpoint
        const result = await get('/v1/account');
    
        if (!result.ok) {
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify({
                  ok: false,
                  data: {
                    baseUrl,
                    authenticated: false,
                    version: VERSION,
                  },
                  error: result.error,
                  _hints: result._hints || [
                    'API key is set but authentication failed. Check that your key is correct.',
                  ],
                }),
              },
            ],
            isError: true,
          };
        }
    
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                ok: true,
                data: {
                  baseUrl,
                  authenticated: true,
                  version: VERSION,
                  account: result.data,
                },
              }),
            },
          ],
        };
      }
    );
  • The handler function that executes the prismism_health tool logic, including API key verification and account connectivity check.
    async () => {
      const baseUrl = getBaseUrl();
      const hasKey = hasApiKey();
    
      if (!hasKey) {
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                ok: true,
                data: {
                  baseUrl,
                  authenticated: false,
                  version: VERSION,
                },
                _hints: [
                  'No API key configured. Set PRISMISM_API_KEY in your MCP config to authenticate.',
                  'Register at https://prismism.dev or use the prismism_register tool to create an account.',
                ],
              }),
            },
          ],
        };
      }
    
      // Verify the key works by hitting the account endpoint
      const result = await get('/v1/account');
    
      if (!result.ok) {
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                ok: false,
                data: {
                  baseUrl,
                  authenticated: false,
                  version: VERSION,
                },
                error: result.error,
                _hints: result._hints || [
                  'API key is set but authentication failed. Check that your key is correct.',
                ],
              }),
            },
          ],
          isError: true,
        };
      }
    
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify({
              ok: true,
              data: {
                baseUrl,
                authenticated: true,
                version: VERSION,
                account: result.data,
              },
            }),
          },
        ],
      };
    }
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses that the tool checks API key configuration and server status, but omits return value format, error states, or idempotency characteristics that would help an agent interpret results.

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?

Two sentences with zero waste: the first states purpose, the second states usage order. Every word earns its place and the description is appropriately front-loaded.

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

Completeness4/5

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

For a simple health check with no parameters, the description covers essential functionality. However, without an output schema, it could briefly mention what indicates success/failure (e.g., boolean or status string) to be fully complete.

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

Parameters4/5

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

The input schema contains zero parameters, which per guidelines establishes a baseline of 4. No parameter documentation is required or present in the description.

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 uses specific verbs ('Verify') and clearly identifies the scope (server running status and API key configuration). It distinguishes this diagnostic tool from operational siblings like prismism_publish or prismism_delete.

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

Usage Guidelines5/5

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

Provides explicit sequencing guidance ('Call this first') and clear context for when to use it ('before doing anything else'), effectively establishing it as a prerequisite check for the other tools.

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/prismism-dev/mcp-server'

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