Skip to main content
Glama

generate_review_outline_data_v1

Generate reproducible literature review outlines from topics or community IDs for academic research, storing structured data in a database.

Instructions

生成综述大纲(确定性,无 LLM)

从 topic 或 comm_ids 生成可复现的综述大纲结构,写入数据库。

Args: topic: 综述主题(与 comm_ids 二选一) comm_ids: 社区 ID 列表(与 topic 二选一) outline_style: 大纲样式,默认 "econ_finance_canonical" rebuild: 是否重建已存在的大纲,默认 False

Returns: outline_id, topic, sections 列表

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNo
comm_idsNo
outline_styleNoecon_finance_canonical
rebuildNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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 of behavioral disclosure. It adds some context: it mentions deterministic generation without LLM, writes to a database, and has a rebuild option. However, it doesn't cover important aspects like permissions needed, rate limits, error conditions, or what '写入数据库' (writes to database) entails operationally. The description doesn't contradict annotations (none exist), but it's incomplete for a mutation tool.

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

Conciseness4/5

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

The description is appropriately sized and front-loaded: the first sentence states the core purpose, followed by a structured Args section. There's no wasted text, though the Returns section could be integrated more smoothly. Every sentence earns its place by adding value, making it efficient for an AI agent to parse.

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?

Given a mutation tool with 4 parameters, 0% schema coverage, no annotations, but an output schema exists, the description is moderately complete. It covers parameters well and states the return values, but lacks behavioral context like side effects, idempotency, or error handling. The output schema reduces the need to explain returns, but more operational guidance would help for a database-writing tool.

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?

Given 0% schema description coverage, the description compensates well by explaining all 4 parameters in the Args section. It clarifies that 'topic' and 'comm_ids' are mutually exclusive ('二选一' - choose one), describes 'outline_style' with a default, and explains 'rebuild' as whether to rebuild existing outlines. This adds meaningful semantics beyond the bare schema, though it doesn't detail possible values for 'outline_style' beyond the default.

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

Purpose4/5

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

The description clearly states the tool's purpose: '生成综述大纲(确定性,无 LLM)从 topic 或 comm_ids 生成可复现的综述大纲结构,写入数据库.' It specifies the verb ('生成' - generate), resource ('综述大纲' - review outline), and key constraints ('确定性,无 LLM' - deterministic, no LLM). However, it doesn't explicitly differentiate from sibling tools like 'draft_lit_review_v1' or 'get_outline_templates', which might have overlapping functionality.

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 usage through its parameter explanations (e.g., 'topic 或 comm_ids 二选一' - topic or comm_ids choose one), suggesting when to use this tool based on available input. However, it lacks explicit guidance on when to choose this tool over alternatives like 'draft_lit_review_v1' or 'get_outline_templates', and doesn't mention prerequisites or exclusions beyond the parameter constraints.

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/h-lu/paperlib-mcp'

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