Skip to main content
Glama
rspace-os

RSpace MCP Server

Official
by rspace-os

get_form

Retrieve detailed form template information to examine structure and field specifications before creating documents or new forms in RSpace.

Instructions

Retrieves detailed information about a specific form template

Usage: Examine form structure before creating documents or new forms Returns: Complete form definition including field specifications

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
form_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • main.py:489-497 (handler)
    The main handler function for the MCP 'get_form' tool. It is decorated with @mcp.tool for registration and simply delegates to the RSpace ELN client to fetch form details by ID.
    @mcp.tool(tags={"rspace"})
    def get_form(form_id: int | str) -> dict:
        """
        Retrieves detailed information about a specific form template
        
        Usage: Examine form structure before creating documents or new forms
        Returns: Complete form definition including field specifications
        """
        return eln_cli.get_form(form_id)
Behavior3/5

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

No annotations are provided, so the description carries full burden. It states the tool retrieves information (implying read-only) and mentions the return content ('Complete form definition including field specifications'), which adds useful context. However, it doesn't disclose potential behavioral traits like error conditions, authentication needs, or rate limits that would be helpful for a read operation.

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 perfectly structured and concise: a clear purpose statement followed by usage guidance and return information. Every sentence earns its place with no wasted words, and it's front-loaded with the core functionality.

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?

Given the tool has an output schema (which handles return values), no annotations, and a simple single parameter, the description is reasonably complete. It covers purpose, usage context, and return content. However, for a tool with no annotations, it could benefit from more behavioral transparency about potential constraints or error cases.

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?

With 0% schema description coverage for the single parameter 'form_id', the description adds no specific parameter information. However, since there's only one parameter and its purpose is implied by the tool name and description context, the baseline is 4. The description doesn't compensate for the schema gap but doesn't need to heavily for a single, obvious parameter.

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 states the specific action ('Retrieves detailed information') and resource ('about a specific form template'), distinguishing it from sibling tools like 'get_forms' (plural) and 'create_form'. It precisely defines what the tool does without being tautological.

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?

The description explicitly provides usage guidance: 'Examine form structure before creating documents or new forms'. This tells the agent when to use this tool (for pre-creation examination) and implies alternatives like 'create_document_from_form' or 'create_form' for actual creation tasks.

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/rspace-os/rspace-mcp'

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