Docvet

Name: Docvet
Author: Alberto-Codes

제작자: Alberto-Codes버전 3.0.1i★ –i내 컴퓨터에서 실행

레지스트리 이름io.github.Alberto-Codes/docvet

설치

개요

제작자가 쓴 설명(영어 원문)

Docstring quality vetting for Python -- enrichment, freshness, coverage, and presence checks

PopNx MCP의 세 기둥

이 세 가지는 절대 하나의 점수로 합치지 않아요. 의견, 측정, 인기는 서로 다른 것이니까요.

사용자 의견i아직 리뷰가 없어요리뷰는 다음 단계에서 계정 기능과 함께 열려요
우리의 기본 점검i1개 중 1개 통과공개된 정보로 점검했으며, 코드는 아직 스캔하지 않았어요
사용 정도i아직 측정 안 함★ –

할 수 있는 일

이 서버는 아직 쉬운 말로 된 요약을 쓰지 못했어요. 아래는 레지스트리에서 읽어 온 사실이에요.

연결 방식: 내 컴퓨터에서 실행
전송 방식: stdio
카테고리: 기타

설치

쓰고 있는 AI 앱을 고른 다음 설정을 복사하세요.

설치하기 전에

기본 점검: 1개 중 1개 통과
내 컴퓨터에서 내 사용자 계정의 권한(파일, 네트워크, 앱)으로 실행돼요.
레지스트리에 입력해야 할 키가 나와 있지 않아요.

필요한 것

PyPIPython의 uv 설치(uvx 명령어용)

어떤 앱을 쓰세요?

ClaudeClaude CodeCursorVS CodeChatGPT

위에서 앱을 고르세요. 기억해 두었다가 다음부터는 버튼에 “…에 설치”라고 표시해요.

Claude Desktop → Settings → Developer → Edit Config를 열고 claude_desktop_config.json에 이 내용을 붙여 넣으세요

{
  "mcpServers": {
    "docvet": {
      "command": "uvx",
      "args": [
        "docvet"
      ]
    }
  }
}

터미널에서 이 명령어를 실행하세요

claude mcp add docvet -- uvx docvet

Cursor에서 열기

또는 설정을 직접 복사하기

프로젝트의 .cursor/mcp.json 또는 ~/.cursor/mcp.json에 붙여 넣으세요

{
  "mcpServers": {
    "docvet": {
      "command": "uvx",
      "args": [
        "docvet"
      ]
    }
  }
}

브라우저가 앱을 열지 물어본 다음, 앱이 설정을 보여 주고 확인을 요청해요. 키 값은 비워 두니 직접 입력하세요.

VS Code에서 열기

또는 설정을 직접 복사하기

프로젝트의 .vscode/mcp.json에 붙여 넣으세요

{
  "servers": {
    "docvet": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "docvet"
      ]
    }
  }
}

브라우저가 앱을 열지 물어본 다음, 앱이 설정을 보여 주고 확인을 요청해요. 키 값은 비워 두니 직접 입력하세요.

이 서버는 내 컴퓨터에서 실행되는데, ChatGPT는 인터넷에 있는 서버에만 연결할 수 있어요. 다른 앱을 고르세요.

선택한 앱은 이 기기의 쿠키에만 저장돼요. 계정은 필요 없어요.

이 설정은 제작자의 레지스트리 정보로 만들었어요. README와 다르면 README를 따르세요.

할 수 있는 일

내 컴퓨터에서 실행돼요. 설치하면 AI 앱에 도구 목록이 나타나요.

기본 점검i

누구나 볼 수 있는 정보를 점검했고, 코드는 읽지 않았어요. 해당하지 않는 항목은 개수에서 뺐어요. · 2026년 11월 6일 점검

✓ 통과
제작자와 저장소 일치
레지스트리 이름이 GitHub 계정 Alberto-Codes 기준으로 확인되었고, 이 계정이 저장소를 소유하고 있어요
… 아직 점검 안 함
계속 관리되고 있음
아직 GitHub에서 이 저장소를 읽어 오지 않았어요
… 아직 점검 안 함
라이선스 있음
아직 GitHub에서 이 저장소를 읽어 오지 않았어요
– 해당 없음
엔드포인트 응답
내 컴퓨터에서 실행되는 서버라 인터넷 엔드포인트가 없어요
– 해당 없음
OAuth로 로그인
내 컴퓨터에서 실행되며, 대신 로컬 설정을 사용해요
… 아직 점검 안 함
도구 설명에 숨겨진 지시 없음
내 컴퓨터에서 실행돼요. 도구 목록은 인터넷 엔드포인트가 있는 서버에서만 읽을 수 있어요

기타 카테고리의 다른 서버와 비교i

이 카테고리의 다른 서버 32505개 중 0%보다 스타가 많아요
이 카테고리의 다른 서버 32505개 중 71%보다 최근에 레지스트리에 공개됐어요
기본 점검 결과가 이 카테고리의 다른 서버 32505개 중 100%와 같거나 더 좋아요

레지스트리에서 이 카테고리의 활성 서버 전체와 비교했어요. 스타는 게시자가 저장소를 소유한 경우에만 세요.

자주 묻는 질문

Docvet, 안전한가요?

해당하는 기본 점검 1개 중 1개를 통과했어요. 코드는 읽지 않았어요. 키나 토큰을 넣기 전에 서버가 어떤 권한을 요구하는지 확인하고, 꼭 필요한 권한만 있는 키를 쓰세요.

어떤 키나 코드가 필요한가요?

레지스트리에 필수 키가 나와 있지 않아요. 다만 처음 쓸 때 로그인을 요구하는 서버도 있어요.

내 컴퓨터에서 실행되나요, 클라우드에서 실행되나요?

내 컴퓨터에서 실행돼요. AI 앱이 필요할 때 실행하고, 데이터는 제작자의 서버를 거치지 않아요(서버 자체가 온라인 서비스를 호출하는 경우는 제외).

아직 관리되고 있나요?

GitHub 저장소는 마지막으로 – 변경됐고, 최신 버전(3.0.1)은 15일 전 레지스트리에 올라왔어요.

어떤 앱에서 쓸 수 있나요?

Claude Desktop, Claude Code, Cursor, VS Code처럼 MCP를 지원하는 앱에서 쓸 수 있어요. 내 컴퓨터에 Python (uv)도 있어야 해요.

대신 쓸 수 있는 건 뭐가 있나요?

같은 카테고리에는: Spec Driven Development, Remote Desktop Commander, topo^alpin

대안

같은 카테고리에서 다른 제작자가 만든 서버예요. 스타 순으로 정렬했어요.

카드 보는 법:★ GitHub 스타i세 기둥: 리뷰 · 점검 · 사용 정도i업데이트 = 최신 버전을 레지스트리에 공개한 날i

Spec Driven Development

제작자: formulahendry

MCP Server that facilitates spec-driven development workflows, not just Vibe Coding.

내 컴퓨터에서 실행★ 440MIT14개월 전 업데이트

설치

Remote Desktop Commander

제작자: desktop-commander

Remote Desktop Commander: use files, terminal and processes on your own computers from any AI app.

클라우드에서 실행★ 211어제 업데이트

설치

topo^alpin

제작자: topoalpin.app

Avalanche bulletins and mountain weather forecasts for any place in the Alps.

클라우드에서 실행오늘 업데이트

설치

제작자의 README

README 열기

제작자의 저장소에서 쓰인 그대로 가져왔어요. PopNx MCP가 검토하거나 보증한 내용이 아니에요. HTML, 이미지, 스크립트는 제거했어요. 링크를 누르면 이 사이트를 벗어나요.

docvet

Better docstrings, better AI.

Why docvet?

docvet combines docstring presence metrics, structural checks, history-based staleness signals, and renderer diagnostics in one CLI, with editor and agent interfaces. These checks help reviewers find documentation gaps; they do not prove that prose describes runtime behavior correctly.

Layer	Check	ruff	interrogate	pydoclint	docvet
1. Presence	"Does a docstring exist?"	Yes (D rules, opt-in)	Yes, with coverage metrics	Skips absent docstrings	Yes, with coverage metrics
2. Style	"Is it formatted consistently?"	Yes (D rules, opt-in)	--	Some parsing/style checks	Limited format checks
3. Completeness	"Do sections and code structure agree?"	Partial (D rules; DOC rules in preview)	--	Arguments, returns, yields, raises, attributes, type hints	AST-based section and agreement checks
4. Accuracy	"What needs review for staleness?"	Structural checks above	--	Structural checks above	Git diff/blame heuristics; no semantic proof
5. Rendering	"Are there parser warnings?"	--	--	--	Griffe diagnostics
6. Visibility	"Is package discovery incomplete?"	--	--	--	Missing `__init__.py` checks

Comparison reviewed 2026-10-21 against primary documentation: Ruff's D103 presence rule and DOC501 exception completeness rule (requires --preview and rule selection), pydoclint's supported checks and styles, and interrogate's coverage documentation. Capabilities depend on enabled rules and configuration; -- means no corresponding check is described in these sources.

pydoclint checks arguments, returns, yields, raises, class attributes, and type hints across Google, NumPy, and Sphinx styles. docvet's enrichment alone has 21 rules, including Raises, Yields, Receives, Warns, Attributes, Examples, cross-references, parameter agreement, and more. Add presence (coverage metrics + threshold enforcement), freshness (git diff/blame staleness signals), griffe rendering compatibility, and mkdocs coverage: 32 rules across 5 checks. Rule totals measure catalog entries, not equivalent coverage between tools.

Structural agreement checks compare documented elements with code structure. Freshness uses change history to suggest review: code can change without invalidating prose, and simultaneous code/docstring edits can still leave incorrect prose. Neither establishes semantic correctness.

What It Checks

Presence (existence) -- 2 rules: missing-docstring overload-has-docstring

Enrichment (completeness) -- 21 rules: missing-raises missing-returns missing-yields missing-receives missing-warns missing-deprecation missing-param-in-docstring extra-param-in-docstring missing-other-parameters missing-attributes undocumented-init-params missing-typed-attributes missing-examples missing-cross-references extra-raises-in-docstring extra-yields-in-docstring extra-returns-in-docstring missing-return-type trivial-docstring prefer-fenced-code-blocks scaffold-incomplete

Freshness (staleness signals) -- 5 rules: stale-signature stale-body stale-import stale-drift stale-age

Griffe (rendering) -- 3 rules: griffe-unknown-param griffe-missing-type griffe-format-warning

Coverage (visibility) -- 1 rule: missing-init

Quickstart

pip install docvet && docvet check --all

For optional griffe rendering checks:

pip install docvet[griffe]

Example output:

src/mypackage/helpers.py:1: missing-docstring Module has no docstring [required]

src/mypackage/utils.py:42: missing-raises Function 'parse_config' raises ValueError but has no Raises section [required] src/mypackage/models.py:15: stale-signature Function 'process' signature changed but docstring not updated [required] src/mypackage/api.py:1: missing-init Package directory missing init.py (invisible to mkdocs) [required]

Configuration

Configure via [tool.docvet] in your pyproject.toml. All checks run and print findings. Checks listed in fail-on cause a non-zero exit code; unlisted checks are treated as warnings.

A check in fail-on that cannot run — most often griffe without the docvet[griffe] extra — never certified the gate you configured, so docvet reports it on stderr and exits 1. With --format json the run object reports status: "unavailable" and an unavailable_checks array, which is what distinguishes it from a gate that found problems. Set fail-on-unavailable = false (or pass --no-fail-on-unavailable) to warn and exit 0 instead. Unavailable checks that nothing gates on stay a quiet skip — though fail-on membership is not the only thing that gates: a min-coverage floor gates presence without naming it there.

[tool.docvet]

exclude = ["tests", "scripts"] fail-on = ["griffe", "coverage"]

[tool.docvet.freshness] drift-threshold = 30 age-threshold = 90

Pre-commit

Add to your .pre-commit-config.yaml:

repos:

repo: https://github.com/Alberto-Codes/docvet rev: v3.0.0 hooks:
id: docvet

For griffe rendering checks, add the optional dependency:

repos:

repo: https://github.com/Alberto-Codes/docvet rev: v3.0.0 hooks:
id: docvet additional_dependencies: [griffe]

GitHub Action

Add docvet to your GitHub Actions workflow — findings appear as inline annotations on your PR:

- uses: Alberto-Codes/docvet@v3.0.0

Select specific checks or pin a version:

- uses: Alberto-Codes/docvet@v3.0.0

with: checks: 'enrichment,freshness' docvet-version: '3.0.0' python-version: '3.13'

The griffe rendering check needs no setup: the action installs docvet[griffe], pinned or not, so every check the checks input offers is available. Note that docvet releases before 1.7.0 declare that extra without an upper bound, so pinning one installs whatever griffe publishes at the time rather than a version docvet was released against.

Behavior change — this can turn a passing build red.

Earlier releases installed plain docvet, so the griffe check was skipped and contributed zero findings. It now runs. determine_run_outcome (src/docvet/reporting.py) returns exit code 1 as soon as any check listed in fail-on reports findings, so if your pyproject.toml has griffe in [tool.docvet] fail-on, your build goes from green to failing with no change on your side. This repository's own ci.yml docvet job is exactly such a consumer.

These are not new problems — it is the check finally running on docstrings that were always broken. To get back to green, fix the griffe findings or remove griffe from fail-on.

AI Agent Integration

For tool-specific integration snippets, see the full AI Agent Integration guide.

Add docvet to your AI coding workflow. Drop this into your CLAUDE.md, .cursorrules, or agent configuration:

## Docstring Quality

After modifying Python functions, classes, or modules, run docvet check and fix all findings before committing.

Recommended pyproject.toml configuration:

[tool.docvet]

fail-on = ["enrichment", "freshness", "coverage", "griffe"]

Subcommand Quick Reference

Command	Description
`docvet check`	Run all enabled checks (default: git diff files)
`docvet check --all`	Run all checks on entire codebase
`docvet check --staged`	Run all checks on staged files only
`docvet presence`	Check for missing docstrings with coverage metrics
`docvet enrichment`	Check for missing docstring sections
`docvet freshness`	Flag potentially stale docstrings via git
`docvet freshness --mode drift`	Review potential staleness via git blame
`docvet coverage`	Find files invisible to mkdocs
`docvet griffe`	Check mkdocs rendering compatibility
`docvet fix`	Scaffold missing docstring sections
`docvet fix --dry-run`	Preview scaffolding changes without writing files
`docvet config`	Show effective configuration with source annotations
`docvet lsp`	Start LSP server for real-time editor diagnostics
`docvet mcp`	Start MCP server for AI agent integration

Better Docstrings, Better AI

AI coding agents rely on docstrings as context when generating and modifying code. Agents modify code but often leave docstrings stale, and research shows stale or incorrect documentation is actively harmful, worse than no docs at all:

Incorrect docs degrade LLM task success by 22.6 percentage points
Comment density improves code generation by 40-54%
Misleading comments reduce LLM fault localization accuracy to 24.55%
Performance drops substantially without docstrings

As the 2025 DORA report puts it: "AI doesn't fix a team; it amplifies what's already there." The only signal correlating with AI productivity is code quality.

docvet's freshness heuristics flag potential staleness for review, and its enrichment rules check supported docstring sections against code structure. Run docvet check in your CI, pre-commit hooks, or agent toolchain.

Badge

Add a badge to your project to show your docs are vetted:

[![docs vetted | docvet](https://img.shields.io/badge/docs%20vetted-docvet-purple)](https://github.com/Alberto-Codes/docvet)

Used By

Are you using docvet? Open a pull request to add your project here.

License

MIT -- see LICENSE for details.

mcp-name: io.github.Alberto-Codes/docvet

Docvet

개요

PopNx MCP의 세 기둥

할 수 있는 일

설치

설치하기 전에

할 수 있는 일

기본 점검i

제작자와 저장소 일치

계속 관리되고 있음

라이선스 있음

엔드포인트 응답

OAuth로 로그인

도구 설명에 숨겨진 지시 없음

기타 카테고리의 다른 서버와 비교i

자주 묻는 질문

대안

Spec Driven Development

Remote Desktop Commander

topo^alpin

제작자의 README

docvet

Why docvet?

What It Checks

Quickstart

Configuration

Pre-commit

GitHub Action

AI Agent Integration

Subcommand Quick Reference

Better Docstrings, Better AI

Badge

Used By

License