Skip to main content
Glama
featherflow

BitScale MCP Server

by featherflow
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

get_workspace_details

Retrieve current BitScale workspace details including plan information, credit balances, search limits, and member counts using your configured API key.

Instructions

Get details about the current BitScale workspace — plan info, credit balances, people/company search limits, and member counts.

The workspace is identified automatically from the API key configured during MCP setup. No parameters needed.

Returns: workspace id, name, plan (name, credits_included, billing_interval, next_billing_date, price), credits (total, used, remaining, plan_credits, rollover, topup), people_company_searches (limit, used, remaining), and members (total, owners, admins, editors).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • main.py:68-83 (handler)
    The implementation of the get_workspace_details MCP tool. It calls the _get helper to fetch details from the /workspace endpoint and returns the result as a formatted JSON string.
    @mcp.tool()
def get_workspace_details() -> str:
    """
    Get details about the current BitScale workspace — plan info, credit
    balances, people/company search limits, and member counts.

    The workspace is identified automatically from the API key configured
    during MCP setup. No parameters needed.

    Returns: workspace id, name, plan (name, credits_included, billing_interval,
    next_billing_date, price), credits (total, used, remaining, plan_credits,
    rollover, topup), people_company_searches (limit, used, remaining),
    and members (total, owners, admins, editors).
    """
    data = _get("/workspace")
    return json.dumps(data, indent=2)

Tool Definition Quality

A4.4/5.0
Behavior4/5

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

No annotations provided, so description carries full burden. It effectively discloses the auto-identification mechanism and exhaustively lists return fields (plan credits, rollover, topup, member roles). Does not explicitly declare read-only/safe nature or rate limits, but 'Get details' implies non-destructive behavior adequately.

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?

Three distinct paragraphs (purpose → mechanism → returns), zero filler. Every sentence adds value: scope definition, auth explanation, and return structure documentation. 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?

Comprehensive for a metadata tool: covers identification method, scope (current workspace), and return payload structure. With output schema existing, the detailed return description is complete but slightly redundant. Could mention error conditions or caching behavior for a 5.

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?

Zero parameters per schema. Baseline 4 applies. Description confirms 'No parameters needed,' aligning perfectly with the empty input schema without redundancy.

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?

Excellent clarity: 'Get details about the current BitScale workspace' uses specific verb+resource, and the content (plan info, credit balances, member counts) clearly distinguishes it from grid-centric siblings like get_grid_details or run_grid.

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

Usage Guidelines4/5

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

Clear context provided: states workspace is 'identified automatically from the API key' and 'No parameters needed,' establishing prerequisites. Lacks explicit 'when not to use' or named alternatives (e.g., vs list_grids), but the auto-identification guidance strongly implies usage context.

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/featherflow/bitscale-mcp'

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