Skip to main content
Glama

Docstar MCP

Docstar MCP is a Model Context Protocol server designed to automate documentation updates based on git changes.

Features

  • Get Recent Changes: Fetches recent commits and diffs from your local git repository.

  • Generate Documentation: Uses an LLM (OpenAI) to analyze changes and generate documentation.

  • Apply Updates: Writes the generated documentation to files.

Related MCP server: Autonomous Documentation MCP

Installation

  1. Navigate to the docstar-mcp directory:

    cd docstar-mcp
  2. Install dependencies:

    npm install
  3. Create a .env file and add your OpenAI API key:

    OPENAI_API_KEY=your_api_key_here
  4. Build the project:

    npm run build

Usage

You can use this MCP server with any MCP-compliant client (e.g., Claude Desktop, specific IDE extensions).

Configuration

Add the following to your MCP client configuration:

{
  "mcpServers": {
    "docstar": {
      "command": "node",
      "args": ["/path/to/docstar-mcp/build/index.js"]
    }
  }
}

Tools

  • get_recent_changes:

    • limit (number): Number of commits to fetch (default: 5).

    • include_diff (boolean): Whether to include diffs (default: true).

  • generate_docs_for_changes:

    • changes_summary (string): The git diff or summary to analyze.

    • context_files (array): Paths to files for additional context.

  • apply_doc_update:

    • file_path (string): Path to the file to update/create.

    • content (string): The documentation content to write.

Available Tools

3 tools
apply_doc_updateC

Apply generated documentation to a file

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesThe documentation content
file_pathYesPath of the file to update/create

TDQS

C2.9/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 behavioral burden. It implies a mutation ('apply... to a file') but does not state whether existing content is overwritten or appended, whether the file/directories are created, whether it is reversible, or what is returned.

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?

A single front-loaded sentence with no waste. It is appropriately terse, though arguably under-specified rather than merely concise.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the definition should clarify the effect on existing file content and the return value. With 100% schema coverage the parameters are covered, but the behavioral picture an agent needs before writing to a file is largely absent.

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%, so both parameters (file_path, content) are already documented in the schema, setting the baseline at 3. The description adds no format, path-resolution, or content-shape details beyond what the schema provides.

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?

States a specific verb (apply), resource (generated documentation) and target (a file), so the agent knows it writes documentation into a file. However, it does not differentiate itself from siblings like generate_docs_for_changes, leaving the boundary between generating and applying implicit.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no prerequisites, and no mention of the sibling tools or how they chain (e.g., generate then apply). Usage is only vaguely inferable from the name.

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

generate_docs_for_changesC

Generate documentation for changes

ParametersJSON Schema
NameRequiredDescriptionDefault
context_filesNoList of file paths to read for extra context
changes_summaryYesSummary of changes (diff)

TDQS

C2.3/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 does not state whether documentation is written to disk, returned as text, requires permissions, or what side effects occur; it only implies that something is generated.

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

Conciseness3/5

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

A single short phrase is concise, but it is under-specified rather than well-structured. There is no front-loading because there is nothing substantive to front-load.

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

Completeness2/5

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

For a tool with no annotations, no output schema, and two inputs, the description is far too thin. It omits usage context, behavioral traits, and output expectations, leaving the agent with only the name and input schema.

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 coverage is 100%, with both parameters documented (changes_summary and context_files). The description adds no parameter semantics, but the baseline is 3 when the schema does the heavy lifting.

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

Purpose2/5

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

The description restates the tool name ('generate_docs_for_changes' → 'Generate documentation for changes') without adding scope or distinguishing it from siblings like get_recent_changes or apply_doc_update. An agent learns nothing beyond the name.

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

Usage Guidelines2/5

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

No when-to-use guidance, no prerequisites, and no mention of alternatives. The two siblings (get_recent_changes, apply_doc_update) are never referenced, leaving the agent to guess the workflow.

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

get_recent_changesC

Get recent git changes

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoNumber of commits to check
include_diffNoWhether to include the diff content

TDQS

C2.9/5.0
Behavior2/5

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

No annotations provided, so the description carries the full burden and does not meet it. It does not disclose scope ('recent' = how far back?), whether diffs are included, whether it is read-only, or what the return shape looks like. Only the word 'git' hints at behavior.

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?

A single four-word sentence, front-loaded and undeniably concise. It is arguably too terse to carry meaning, but as conciseness goes it wastes nothing.

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

Completeness2/5

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

For a git-inspection tool with no annotations and no output schema, the description should explain the retrieval scope and whether it is safe/read-only. It leaves both unaddressed, and gives no hint about the sibling relationship that would make this tool's role obvious.

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%, so the schema already documents both parameters (limit, include_diff) with defaults. The description adds nothing about parameters, which is acceptable given full schema coverage — baseline 3.

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?

Clear verb+resource ('Get recent git changes') and the tool is distinguishable from siblings by inspection (generate_docs_for_changes and apply_doc_update are about docs, this is about retrieving changes). However the description doesn't explicitly differentiate itself from siblings, and 'recent' is undefined without opening the schema.

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

Usage Guidelines2/5

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

No when-to-use guidance, no alternatives named, no conditions. An agent must infer that this is the retrieval step that feeds generate_docs_for_changes, but that relationship is never stated.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 3 tool updatesv0.1.0
    • First observedapply_doc_update
    • First observedgenerate_docs_for_changes
    • First observedget_recent_changes

TDQS

B3.2/5.0

Scored across 3 tools

Disambiguation5/5

The three tools form a clear sequential pipeline: retrieve changes, generate docs, apply update. Each has a distinct action and resource, so an agent can easily select the right one.

Naming Consistency5/5

All names use snake_case with a verb-first pattern (get_, generate_, apply_) followed by a noun/object. Consistent and predictable throughout.

Tool Count5/5

Three tools perfectly match the narrow purpose of a documentation-generation pipeline; each earns its place with no redundancy.

Completeness4/5

The surface covers the end-to-end workflow (fetch, generate, apply) but lacks optional steps like previewing generated docs, targeting specific files, or rolling back changes.

Related MCP Connectors

Related MCP Servers