Skip to main content
Glama
dixitayush
by dixitayush

start_api_server

Turn a Mermaid ER diagram into a running REST and GraphQL API server, providing CRUD endpoints for all entities in the diagram.

Instructions

Start the REST/GraphQL API server for the entities in the ER diagram.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
diagramNoMermaid ER diagram text. Uses configured source if not provided.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv1.0.0

TDQS

A3.5/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only says 'Start' without revealing side effects such as whether the server runs in the background, blocks the process, binds a port, requires auth, is idempotent, or how to stop it. This is a significant gap for an action that likely starts a long-running process.

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?

One direct sentence with a clear verb, object, and domain. No filler or redundant phrasing; the key information is front-loaded.

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?

The description is adequate for a simple one-parameter start command, but it misses lifecycle and side-effect information. With no output schema, an agent does not know what a successful invocation returns, whether the server is long-running, or how to confirm it is ready—so the definition is acceptable but not complete.

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% for the single 'diagram' parameter, so the baseline is 3. The tool description adds a little domain context by tying the server to the ER diagram entities, but it does not meaningfully clarify parameter format, defaults, or the fallback to configured source—that is already covered by the schema.

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 clearly identifies the action ('Start'), the resource ('REST/GraphQL API server'), and the scope ('for the entities in the ER diagram'). This distinguishes it from sibling tools like stop_api_server and get_api_endpoints without needing to inspect their schemas.

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 implies when to use the tool—after working with an ER diagram and before interacting with API endpoints—but it does not explicitly state when not to use it or mention alternatives. It also does not reference the natural counterpart stop_api_server, leaving some usage context to inference.

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

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/dixitayush/mcp-api'

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